Changed version number and README.md (#52)

* Changed version number and README.md
* README small fixes
* Update setup.cfg github urls and description

Co-authored-by: Art Vandelay <start.vandelay@gmail.com>
Co-authored-by: Luka Kilic <kilic.luka@gmail.com>

Author: 3 people

README.md

@@ -1,8 +1,73 @@
-# infobip-python-channels
-Python client for Infobip's channels API.
+# infobip-api-python-sdk
+Python client for Infobip's  API channels.
 
+#### Table of contents:
+
+- [General Info](#general-info)
+- [License](#license)
+- [Installation](#installation)
+- [Code example](#code-example)
+- [Testing](#testing)
+- [Enable pre-commit hooks](#enable-pre-commit-hooks)
+- [Generating distribution package](#generating-distribution-package)
+- [Uploading distribution package on TestPyPI](#uploading-distribution-package-on-testpypi-for-testing-purposes)
+- [Installing your newly uploaded package](#installing-your-newly-uploaded-package)
+
+
+## General Info
+
+For `infobip-api-python-sdk` versioning we use [Semantic Versioning](https://semver.org) scheme.
+
+Python 3.6 is minimum supported version by this library.
+
+## License
+
+Published under [MIT License](LICENSE).
+
+## Installation
+
+Install the library by using the following command:
+```
+pip install infobip-api-python-sdk
+```
+
+## Code Example
+To use the package you'll need an Infobip account.
+If you don't already have one, you can create a free trial account [here](https://www.infobip.com/signup).
+
+In this example we will show how to send WhatsApp text message.
+First step is to import necessary channel, in this case WhatsApp channel.
+
+```
+from infobip_channels import WhatsAppChannel
+```
+
+Now you can create instance of `WhatsAppChannel` with your `base_url` and `api_key`.
+
+```
+c = WhatsAppChannel.from_auth_params({
+    "base_url": "<your_base_url>",
+    "api_key": "<your_api_key>"
+})
+```
+After that you can access all the methods from `WhatsAppChannel`.
+To send text message you can use `send_text_message` method and add correct payload:
+```
+response = c.send_text_message(
+    {
+      "from": "<WhatsApp sender number from your Infobib account>",
+      "to": "<Number that will receive WhatsApp message>",
+      "messageId": "a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
+      "content": {
+        "text": "Some text"
+      },
+      "callbackData": "Callback data",
+      "notifyUrl": "https://www.example.com/whatsapp"
+    }
+)
+```
 ## Testing
-To run tests position yourself in the project's root while your virual environment
+To run tests position yourself in the project's root while your virtual environment
 is active and run:
 ```
 python -m pytest
@@ -27,7 +92,7 @@ To check installation run:
 pre-commit --version
 ```
 If installation was successful you will see version number.
-Pre-commit configuration you can find in `.pre-commit-config.yaml`.
+You can find the Pre-commit configuration in `.pre-commit-config.yaml`.
 Install the git hook scripts:
 ```
 pre-commit install
@@ -36,9 +101,9 @@ Run against all files:
 ```
 pre-commit run --all-files
 ```
-If setup was successful pre-commit will run will now run on every commit.
-Every time you clone a project using pre-commit running `pre-commit install`
-should always be the first thing you do.
+If setup was successful pre-commit will run on every commit.
+Every time you clone a project that uses pre-commit, running `pre-commit install`
+should be the first thing you do.
 
 
 ## Generating distribution package
@@ -47,10 +112,11 @@ Make sure you have the latest version of PyPA's
 ```
 python -m pip install --upgrade build
 ```
-
+After installation check `setup.cfg` file for metadata.
+Name and version are used for file generation.
+Make sure that you appropriately change version before build.
 Update the `version` in the  `setup.cfg` file to the desired one.
 
-
 Now run this command from the same directory where pyproject.toml is located:
 ```
 python -m build

setup.cfg

@@ -1,15 +1,15 @@
 [metadata]
 name = infobip-channels
-version = 0.0.4
+version = 1.0.0
 author = Luka Kilic
 author_email = kilic.luka@gmail.com
-description = Infobip's channels API package
+description = Infobip channels API client
 long_description = file: README.md
 long_description_content_type = text/markdown
-keywords = infobip, channels, whatsapp, api
-url = https://github.com/kilicluka/infobip-python-channels
+keywords = infobip, sdk, channels, whatsapp, api
+url = https://github.com/infobip-community/infobip-api-python-sdk
 project_urls =
-    Bug Tracker = https://github.com/kilicluka/infobip-python-channels/issues
+    Bug Tracker = https://github.com/infobip-community/infobip-api-python-sdk/issues
 classifiers =
     Programming Language :: Python :: 3
     License :: OSI Approved :: MIT License