From c4ddd2437e06efe7b8d6ee093ec7efc203666584 Mon Sep 17 00:00:00 2001 From: Dan Sosedoff Date: Mon, 13 Oct 2014 21:02:04 -0500 Subject: [PATCH] License, readme --- LICENSE | 18 +++++++++++++++ README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 76 insertions(+), 7 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6511981 --- /dev/null +++ b/LICENSE @@ -0,0 +1,18 @@ +Copyright (c) 2014 Dan Sosedoff + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index e0a28dc..2de1591 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,56 @@ Web-based PostgreSQL database browser written in Go. +## Overview + +This is a web-based browser for PostgreSQL database server. Its written in Go +and works on Mac OSX, Linux and Windows machines. Main idea behind using Go for the backend +is to utilize language's ability for cross-compile source code for multiple platforms. +This project is an attempt to create a very simple and portable application to work with +PostgreSQL databases. + +## Installation + +Please visit [Github Releases](https://github.com/sosedoff/pgweb/releases) to download a +precompiled binary for your operating system. + +Currently supported: + +- OSX 64bit +- Linux 32/64bit +- Windows 32/64bit + ## Usage +To start a server, type: `pgweb`. Application will try to connect to the local PostgreSQL +server with `postgresql` user and select `postgresql` database. You can specify connection +flags, like database, host or user. See `CLI` section of this readme. + +You can also specify a connection URI instead of settings individual connection settings: + +``` +pgweb --url postgresql://user:password@host:port/database +``` + +It works great with [Heroku Postgres](https://postgres.heroku.com) if you need +to troubleshoot production database or simply run a few queries. + +## CLI + CLI options: ``` --h, --host= Server hostname or IP (localhost) --p, --port= Server port (5432) --u, --user= Database user (postgres) --d, --db= Database name (postgres) - --url= Database connection string (postgresql://...) - --ssl= SSL option (disable) +Usage: + pgweb [OPTIONS] + +Application Options: + -d Enable debugging mode (false) + --url= Database connection string + --host= Server hostname or IP (localhost) + --port= Server port (5432) + --user= Database user (postgres) + --db= Database name (postgres) + --ssl= SSL option (disable) ``` ## Compile from source @@ -30,4 +69,16 @@ make deps make dev ``` -This will produce `pgweb` binary in the current directory. \ No newline at end of file +This will produce `pgweb` binary in the current directory. + +## Contributors + +- Dan Sosedoff - https://twitter.com/sosedoff +- Masha Safina - https://twitter.com/mashasafina +- Jeff Canty - https://twitter.com/cantyjeffrey + +## License + +The MIT License (MIT) + +Copyright (c) 2014 Dan Sosedoff, \ No newline at end of file