diff --git a/README.md b/README.md new file mode 100644 index 0000000..6b47556 --- /dev/null +++ b/README.md @@ -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 +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 0eb24ea..0000000 --- a/README.rst +++ /dev/null @@ -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 `_ 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 `_ 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