Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bjascob committed Jan 14, 2020
1 parent 556c476 commit bdfc818
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,18 @@ The library includes a very simple HTTP Server for basic data types and a Proxy

The library also contains a DataContainer utility class to encapsulate pickling, gzipping, loading and saving functionality. This simplifies some common data operations.

The only external requirement is the commonly used "requests" library.
The only external requirement is the commonly used "requests" library and its sub-dependencies.


## Documentation
For the latest documentation, see **[ReadTheDocs](https://pythondataserve.readthedocs.io/en/latest/)**. Alternatively, you can view the markup files directly in the __*docs*__ folder of this project.

You can see example implementations in the __*tests*__ folder.

## Setup
The project is designed to work with python 3.

To install do..
```
pip3 install dataserve
```

0 comments on commit bdfc818

Please sign in to comment.