Skip to content

Commit

Permalink
README.md updated: Features, TODO and Contributing info added.
Browse files Browse the repository at this point in the history
  • Loading branch information
girish946 committed Aug 17, 2019
1 parent b37e105 commit 07e574d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ $ cd local-paste
$ pip install -r requirements.txt
```

If you are using `pipenv`, the instructions are as follows.
```bash
$ git clone https://github.com/girish946/local-paste
$ cd local-paste
$ pipenv install
```

## Usage


Expand Down Expand Up @@ -41,3 +48,27 @@ $ python testLP.py
```

or go to `http://0.0.0.0:8000/api/CreateDb` from your browser.

## Features

* Create, Update, Search and Delete the pastes.
* Syntax heighlighting while viewing a paste.
* Copy the paste to clipboard from the gui.
* REST API.
* Can be hosted on a low power machine like (RaspberryPi/OrangePi).

## TODO

Please take a look at [Issues](https://github.com/girish946/local-paste/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
For the TODO list.

## Contributing.

Bugs and feature requests can be made via [GitHub
issues](https://github.com/girish946/local-paste/issues).

Pull requests are also welcome via git.

LocalPaste uses [the Black python code formatter](https://github.com/python/black)
to keep coding style consistent; you may wish to have it installed to make pull
requests easier.

0 comments on commit 07e574d

Please sign in to comment.