refactoring readme docs

Author: sadayamuthu

README.rst

@@ -3,21 +3,21 @@ logmetrics-python
 =================
 
 
-.. image:: https://img.shields.io/pypi/v/logmetrics_python.svg
-        :target: https://pypi.python.org/pypi/logmetrics
+.. image:: https://img.shields.io/pypi/v/logmetrics_sdk.svg
+        :target: https://pypi.python.org/pypi/logmetrics_sdk
 
-.. image:: https://img.shields.io/travis/ksadayamuthu/logmetrics_python.svg
+.. image:: https://img.shields.io/travis/ksadayamuthu/logmetrics_sdk.svg
         :target: https://travis-ci.org/devxchangeio/logmetrics-python
 
-.. image:: https://readthedocs.org/projects/logmetrics-python/badge/?version=latest
-        :target: https://logmetrics-python.readthedocs.io/en/latest/?badge=latest
+.. image:: https://readthedocs.org/projects/logmetrics/badge/?version=latest
+        :target: https://logmetrics.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status
 
 Python Boilerplate contains all the boilerplate you need to create a Python package.
 
 
 * Free software: Apache Software License 2.0
-* Documentation: https://logmetrics-python.readthedocs.io.
+* Documentation: https://logmetrics_sdk.readthedocs.io.
 
 
 Features

docs/conf.py

@@ -22,7 +22,7 @@
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
-import logmetrics_python
+import logmetrics_sdk
 
 # -- General configuration ---------------------------------------------
 
@@ -56,9 +56,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = logmetrics_python.__version__
+version = logmetrics_sdk.__version__
 # The full version, including alpha/beta/rc tags.
-release = logmetrics_python.__version__
+release = logmetrics_sdk.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/installation.rst

@@ -12,9 +12,9 @@ To install logmetrics_python, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install logmetrics_python
+    $ pip install logmetrics_sdk
 
-This is the preferred method to install logmetrics_python, as it will always install the most recent stable release.
+This is the preferred method to install logmetrics_sdk, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -26,19 +26,19 @@ you through the process.
 From sources
 ------------
 
-The sources for logmetrics_python can be downloaded from the `Github repo`_.
+The sources for logmetrics-python can be downloaded from the `Github repo`_.
 
 You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/devxchangeio/logmetrics_python
+    $ git clone git://github.com/devxchangeio/logmetrics-python
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/devxchangeio/logmetrics_python/tarball/master
+    $ curl -OJL https://github.com/devxchangeio/logmetrics-python/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Github repo: https://github.com/devxchangeio/logmetrics_python
-.. _tarball: https://github.com/devxchangeio/logmetrics_python/tarball/master
+.. _Github repo: https://github.com/devxchangeio/logmetrics-python
+.. _tarball: https://github.com/devxchangeio/logmetrics-python/tarball/master

docs/usage.rst

@@ -2,6 +2,6 @@
 Usage
 =====
 
-To use logmetrics_python in a project::
+To use logmetrics_sdk in a project::
 
-    import logmetrics_python
+    import logmetrics_sdk

requirements_dev.txt

@@ -51,6 +51,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/devxchangeio/logmetrics-python',
-    version='1.0.1',
+    version='1.0.2',
     zip_safe=False,
 )