fix readme

README.md

@@ -1,68 +1,77 @@
 <div align="center">
-	<h1>My awesome organization | My Awesome project</h1>
-	<em>Description of my awesome project</em></br>
+<h1>Peeper</h1>
+<em>A tool to dig deep into telemetry data</em></br></br>
+</div>
 
-<a href="https://landscape.io/github/MY_USERNAME/MY_REPOSITORY/master"><img src="https://landscape.io/github/MY_USERNAME/MY_REPOSITORY/master/landscape.svg?style=flat"></a> <a href="https://codeclimate.com/github/MY_USERNAME/MY_REPOSITORY"><img src="https://lima.codeclimate.com/github/MY_USERNAME/MY_REPOSITORY/badges/gpa.svg"></a> <a href="https://www.python.org/download/releases/3.6.0/"><img src="https://img.shields.io/badge/Python-3.6-blue.svg"></a></br>
+<div align="center">
+<a href="https://saythanks.io/to/sirfoga"><img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say Thanks!" /></a>
+</div>
 
-<a href="https://github.com/MY_USERNAME/MY_REPOSITORY/pulls"><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a> <a href="https://github.com/MY_USERNAME/MY_REPOSITORY/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"></a> <a href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FMY_USERNAME%2FMY_REPOSITORY?ref=badge_shield"><img src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FMY_USERNAME%2FMY_REPOSITORY.svg?type=shield"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
 
+<details>
+  <summary>Table of Contents</summary>
 
+* [Examples](#examples)
+* [Install](#install)
+* [Usage and documentation](#usage-and-documentation)
+* [Questions and issues](#questions-and-issues)
+* [License](#license)
 
-<a href="https://saythanks.io/to/sirfoga"><img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say Thanks!" /></a>
-</div>
+</details>
 
-## Install
-```shell
-$ 
-```
-*To install from source*
 
+## Examples
 
-## Usage
-```shell
-$ 
-```
-*See the [documentation](/docs) for more information*
+### Do something awesome
 
+#### Using `peeper`
+```python
+import antigravity
+```
 
-## Warning
-### API
-This script is for personal use only. It simulates a standard user session (i.e., in the browser), logging in using cookies and an authorization ticket. This makes the script pretty brittle. If you're looking for a more reliable option, particularly if you wish to use this for some production service, don't put too much of your trust.
+## Install
+<a href="https://pypi.org/project/raceup-peeper/"><img alt="PyPI version" src="https://badge.fury.io/py/raceup-peeper.svg"></a>
 
-### REST endpoints
-As this script doesn't use the official/paid API, the endpoints to use are known by reverse engineering browser sessions. And as the website changes over time, chances are that this script gets broken.
+Different ways, all equals
 
+### via `pipenv`
+- ```$ pipenv install .```
+- ```$ make install```
 
-## Got questions?
+### via `pip`
+- ```$ pip3 install raceup-peeper```
+- ```$ make pip-install```
 
-If you have questions or general suggestions, don't hesitate to submit
-a new [Github issue](https://github.com/MY_USERNAME/MY_REPOSITORY/issues/new).
+### fast install
+- ```make fast-init``` just copies source files to distribution files ... run it only if you're sure about dependencies
 
 
-## Contributing
-[Fork](https://github.com/MY_USERNAME/MY_REPOSITORY/fork) | Patch | Push | [Pull request](https://github.com/MY_USERNAME/MY_REPOSITORY/pulls)
+## Usage and documentation
+<a href="https://peeper.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/peeper/badge/?version=latest"></a>
 
-#### JavaScript Standard Style
+Browse the online documentation here](https://peeper.readthedocs.io/en/latest/)
+or make your own by `make docs`
 
-MY_REPOSITORY uses [JavaScript Standard Style](https://github.com/feross/standard).
 
-[![js-standard-style](https://raw.githubusercontent.com/feross/standard/master/badge.png)](https://github.com/feross/standard)
+## Contributing and feedback
+<a href="https://github.com/raceup/peeper/issues"><img alt="Contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"></a>
+<a href="https://opensource.org/licenses/MIT"><img alt="Open Source Love" src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a>
 
+0. [open an issue](https://github.com/raceup/peeper/issues/new)
+0. [fork](https://github.com/raceup/peeper/fork) this repository
+0. create your feature branch (`git checkout -b my-new-feature`)
+0. commit your changes (`git commit -am 'Added my new feature'`)
+0. publish the branch (`git push origin my-new-feature`)
+0. [open a PR](https://github.com/raceup/peeper/compare)
 
-## Feedback
-Suggestions and improvements are [welcome](https://github.com/MY_USERNAME/MY_REPOSITORY/issues)!
+Suggestions and improvements are [welcome](https://github.com/raceup/peeper/issues)!
 
 
 ## Authors
-
-| [![MY_USERNAME](https://avatars0.githubusercontent.com/u/14162628?s=128&v=4)](https://github.com/MY_USERNAME "Follow @MY_USERNAME on Github") |
+| [![sirfoga](https://avatars0.githubusercontent.com/u/14162628?s=128&v=4)](https://github.com/sirfoga "Follow @sirfoga on Github") |
 |---|
-| [Stefano Fogarollo](https://MY_USERNAME.github.io) |
-
-
-## Thanks
-Thanks to anyone who ever loved this awesome project. 
+| [Stefano Fogarollo](https://sirfoga.github.io) |
 
 
 ## License
-[MIT License](https://opensource.org/licenses/MIT)
+<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>

docs/index.rst

@@ -43,18 +43,14 @@ Behold, the power of Peeper
 ---------------------------
 
 Do something awesome
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 Using ``peeper``
 ^^^^^^^^^^^^^^^^
 
 .. code:: python
 
-    >>> from hal.tests.gen import TestWriter
-    >>> src = "path to module source folder"
-    >>> out = "path to output folder"
-    >>> w = TestWriter(src)
-    >>> w.write_tests(out)
+    >>> import antigravity
 
 
 Install