Restructure readme

This commit is contained in:
Dan Sosedoff 2014-12-29 20:03:35 -06:00
parent e5ef5b93e1
commit fc5d7c2045

View File

@ -7,34 +7,36 @@ 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.
Pgweb is a web-based database browser for PostgreSQL, written in Go and works
on OSX, Linux and Windows machines. Main idea behind using Go for backend development
is to utilize ability of the compiler to produce zero-dependency binaries for
multiple platforms. Pgweb was created as an attempt to build very simple and portable
application to work with local or remote PostgreSQL databases.
<img src="screenshots/browse.png" width="345px" />
<img src="screenshots/query.png" width="345px" />
Features:
## Features
- Connect to local or remote server
- Browse tables and table rows
- Get table details: structure, size, indices, row count
- Execute SQL query and run analyze on it
- Works on OSX, Linux and Windows
- Zero dependencies
- Simple installation (distributes as a single binary)
- Connect to local or remote servers
- Browse tables and table data
- Get table details: structure, size, indeces, row count
- Run / analyze custom queries
- Export query results to CSV
- View query history
- Save server bookmarks
- Query history
- Server bookmarks
Visit [wiki Pages](https://github.com/sosedoff/pgweb/wiki) for more details
Visit [WIKI](https://github.com/sosedoff/pgweb/wiki) for more details
## Installation
[Precompiled binaries](https://github.com/sosedoff/pgweb/releases) for supported
operating systems are available.
Check [wiki](https://github.com/sosedoff/pgweb/wiki/Installation) for more installation
options.
[More installation options](https://github.com/sosedoff/pgweb/wiki/Installation)
## Usage
@ -60,13 +62,12 @@ pgweb --url postgres://user:password@host:port/database?sslmode=[mode]
[![Heroku Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/sosedoff/pgweb)
## Contributing
## Contribute
- Fork repository
- Create a feature or bugfix branch
- Open a new pull request
- Use github issues for any questions
- Use [github issues](https://github.com/sosedoff/pgweb/issues) for any questions
## Contact