Merge pull request #2 from arthuRHD/style/readme_lint

📝 format markdown and rewording

CONTRIBUTING.md

@@ -1,24 +1,26 @@
-# Contributing  to the pysgconnect library
+# Contributing to the pysgconnect library
 
-First, thank you for taking the time to contribute to pysgconnect library! :+1: 
+First, thank you for taking the time to contribute to pysgconnect library! :+1:
 
 ## How to Contribute
 
 To report any bug and ask for a new feature, please create an issue.
 
 ### Your First Contribution
-Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub]
-(https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+
+Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
 
 ### Submit a Pull Request
+
  1. Provide a proper description on the pull request.
  2. Link your pull request to issue if you are solving one.
  3. Your code must have a proper test.
  4. Please provide the documentation wherever needed.
- 5. Please update the ADR for documenting your architectural decisions. 
- 6. Use the recommender coding styles.
+ 5. Please update the ADR for documenting your architectural decisions.
+ 6. Use the recommended coding styles.
 
 ### Participate in Reviews
-A good review will always help us to improve the quality of our deliverables. 
-Reviews are mainly for a feedback which will help the developers to get a different perception. 
-To have an effective review, please raise a PR with small amount of changes. If you have large amount of changes, the review will be more painful and less effective. 
+
+A good review will always help us to improve the quality of our deliverables.
+Reviews are mainly for a feedback which will help the developers to get a different perception.
+To have an effective review, please raise a PR with small amount of changes. If you have a large amount of changes, the review will be more painful and less effective.

README.md

@@ -1,26 +1,35 @@
 # pysgconnect
+
 Python package to interact with SGConnect
 
 ## Install
 
 You can install this package by using Pypi:
 
-     ```shell
-     pip install pysgconnect
-     ```
+```sh
+pip install pysgconnect
+```
 
 ## Usage
 
 ### Protect HTTP requests
+
 ```python
 from pysgconnect import SGConnectAuth
 from requests import Session
 
-s = Session()
+session = Session()
 # Do not hardcode your credential directly in your scripts, use a secure Vault solution instead
 client_id = 
 client_secret =
-s.auth = SGConnectAuth(client_id, client_secret, scopes=['myscope'], env='PRD')
 
-r = s.get('https://api.foo.socgen')
+session.auth = SGConnectAuth(client_id, client_secret, scopes=['myscope'], env='PRD')
+
+request = session.get('https://api.sgmarkets.com/foo/v1/bar')
+```
+
+### Development
+
+```sh
+pip install -e .
 ```