elia/shortenit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Converts README from rst to md

Browse source
This commit is contained in:
Elia el Lazkani 2021-03-20 12:02:42 +01:00
parent 3fa367602f
commit d8ccfeeb14
2 changed files with 22 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# Shortenit
Shortenit is a tool to shorten urls.
**NOTE**: This is a very early draft project. Contributions are welcome.
## Running
To run `shortenit`, first we need to have a running database. Shortenit uses [CouchDB](https://couchdb.apache.org/) as a database. CouchDB can run as a docker container.
```text
$ docker run -p 5984:5984 -d couchdb
```
At this point, visit the local instance link [http://localhost:5984](http://localhost:5984/) and create the user credentials configured in [config/config.py](config/config.py).
Once the database is up and running and the credentials have been created, shortenit can be ran.
```text
$ pip install -e .
$ shortenit
```

26
README.rst
View file

@ -1,26 +0,0 @@
Shortenit
=========
Shortenit is a tool to shorten urls.
**NOTE**: This is a very early draft project. Contributions are welcome.
Running
-------
To run ``shortenit``, first we need to have a running database. Shortenit uses `CouchDB <https://couchdb.apache.org/>`_ as a database.
CouchDB can run as a docker container.
.. code:: text
$ docker run -p 5984:5984 -d couchdb
At this point, visit the local instance `link <http://localhost:5984/>`_ and create the user credentials configured in ``config/config.py``.
Once the database is up and running and the credentials have been created, shortenit can be ran.
.. code:: text
$ pip install -e .
$ shortenit