Skip to content

Commit

Permalink
Completes documentation on Github
Browse files Browse the repository at this point in the history
  • Loading branch information
fako committed Oct 16, 2019
1 parent 4c6b9f1 commit 59021af
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Build Status](https://travis-ci.com/fako/datagrowth.svg?branch=master)](https://travis-ci.com/fako/datagrowth)

DATAGROWTH
==========

Expand All @@ -11,10 +13,24 @@ Installation
You can install Datagrowth with your Django application by running

```bash
pip install git+https://github.com/fako/datagrowth.git
pip install datagrowth
```


Getting started
---------------

Currently there are two major use cases.
The **Resources** provide a way to uniformly gather data from very different sources.
**Configurations** are a way to store and transfer key-value pairs,
which your code can use to act on different contexts.

Follow these guides to get an idea how you can use Datagrowth:

* [Resources](https://data-scope.com/datagrowth/resources/)
* [Configurations](https://data-scope.com/datagrowth/configuration/)


Running the tests
-----------------

Expand Down

0 comments on commit 59021af

Please sign in to comment.