diff --git a/README.rst b/README.rst index 116d413..a120c52 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,25 @@ Poznaj ====== -.. image:: https://travis-ci.org/kj-wroclaw/poznaj-backend.svg?branch=master - :target: https://travis-ci.org/kj-wroclaw/poznaj-backend +.. image:: https://travis-ci.org/KlubJagiellonski/poznaj-app-backend.svg?branch=master + :target: https://travis-ci.org/KlubJagiellonski/poznaj-app-backend :alt: Build Status -.. image:: http://poznajwroclaw-backend.readthedocs.io/en/latest/ - :target: https://readthedocs.org/projects/poznajwroclaw-backend/badge/?version=latest +.. image:: https://readthedocs.org/projects/poznaj-wrocaw/badge/?version=latest + :target: http://poznaj-wrocaw.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status -.. image:: https://codecov.io/gh/kj-wroclaw/poznaj-backend/branch/master/graph/badge.svg - :target: https://codecov.io/gh/kj-wroclaw/poznaj-backend +.. image:: https://codecov.io/gh/KlubJagiellonski/poznaj-app-backend/branch/master/graph/badge.svg + :target: https://codecov.io/gh/KlubJagiellonski/poznaj-app-backend :alt: Codecoverage Status +.. image:: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/shield.svg + :target: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/ + :alt: Updates + +.. image:: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/python-3-shield.svg + :target: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/ + :alt: Python 3 This `Django`_ project includes code for backend of Poznaj Wrocław application. It tries to follow `12 Factor App Guinness `_. @@ -40,8 +47,8 @@ Documentation Documentation for this project is available in the `docs`_ directory and `online`_. -.. _docs: https://github.com/kj-wroclaw/poznaj-backend/tree/master/docs -.. _online: http://poznaj-backend.readthedocs.io/en/latest/index.html +.. _docs: https://github.com/KlubJagiellonski/poznaj-app-backend/tree/master/docs +.. _online: http://poznaj-wrocaw.readthedocs.io/en/latest/ If you would like to browse the documentation locally, you can do so with `sphinx`: @@ -61,21 +68,21 @@ If you would like to browse the documentation locally, you can do so with `sphin Getting help ------------ -Use the `issue tracker `_ to follow the development conversation. -If you find a bug not listed in the issue tracker, please `file a bug report `_. +Use the `issue tracker `_ to follow the development conversation. +If you find a bug not listed in the issue tracker, please `file a bug report `_. Getting involved ---------------- We welcome your feedback and contributions. See the `contribution guidelines`_ for more details. -.. _contribution guidelines: https://github.com/kj-wroclaw/poznaj-backend/blob/master/.github/CONTRIBUTING.md +.. _contribution guidelines: https://github.com/KlubJagiellonski/poznaj-app-backend/blob/master/.github/CONTRIBUTING.md License ------- -1. `LICENSE `_ +1. `LICENSE `_ Credits ------- diff --git a/docs/changelog.rst b/docs/changelog.rst index 3aa0172..14b7308 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,6 +4,10 @@ Changelog All enhancements and patches to Poznaj backend will be documented in this file. This project adheres to `Semantic Versioning `_. +v1.3.0 (2017-03-11) ++++++++++++++++++++ +* Migrate docstrings @krzysztofzuraw + v1.2.0 (2017-03-05) +++++++++++++++++++ * Stories can be filtered by lat/long @krzysztofzuraw diff --git a/docs/installation.rst b/docs/installation.rst index 9a692b9..f96a2b7 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -7,7 +7,7 @@ Clone the repository Using the console, navigate to the root directory in which your projects live and clone this project's repository: :: - $ git clone git@github.com:kj-wroclaw/poznaj-backend.git + $ git clone git@github.com:KlubJagiellonski/poznaj-app-backend.git $ cd poznaj-backend You may also wish to fork the repository on GitHub and clone the resultant personal fork.