Merge pull request #46 from bsolomon1124/readme-touchups

Touch up README.md

Author: bsolomon1124

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Matt Lisivick
+Copyright (c) 2018-2019 Matt Lisivick
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,34 +1,42 @@
 # newsapi-python
-A Python client for the [News API](https://newsapi.org/docs/)
 
-[![PyPI version](https://badge.fury.io/py/newsapi-python.svg)](https://badge.fury.io/py/newsapi-python)
+A Python client for the [News API](https://newsapi.org/docs/).
 
-##### Provided under MIT License by Matt Lisivick.
-*Note: this library may be subtly broken or buggy. The code is released under
-the MIT License – please take the following message to heart:*
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+[![License](https://img.shields.io/github/license/mattlisiv/newsapi-python.svg)](https://github.com/mattlisiv/newsapi-python/blob/master/LICENSE.txt)
+[![PyPI](https://img.shields.io/pypi/v/newsapi-python.svg)](https://pypi.org/project/newsapi-python/)
+[![Status](https://img.shields.io/pypi/status/newsapi-python.svg)](https://pypi.org/project/newsapi-python/)
+[![Python](https://img.shields.io/pypi/pyversions/newsapi-python.svg)](https://pypi.org/project/newsapi-python)
+
+## License
+
+Provided under [MIT License](https://github.com/mattlisiv/newsapi-python/blob/master/LICENSE.txt) by Matt Lisivick.
+
+```
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
 
-## General 
-
-This is a Python client library for News API V2. The functions for the library should mirror the
-endpoints from the [documentation](https://newsapi.org/docs/endpoints). 
+## General
 
+This is a Python client library for [News API V2](https://newsapi.org/).
+The functions and methods for this library should mirror the
+endpoints specified by the News API [documentation](https://newsapi.org/docs/endpoints).
 
 ## Installation
-Installation for the package can be done via pip.
 
-```commandline
-    pip install newsapi-python
+Installation for the package can be done via `pip`:
+
+```bash
+$ python -m pip install newsapi-python
 ```
 
 ## Usage
 
-After installation, import client into your project:
+After installation, import the client class into your project:
 
 ```python
 from newsapi import NewsApiClient
@@ -41,19 +49,29 @@ api = NewsApiClient(api_key='XXXXXXXXXXXXXXXXXXXXXXX')
 ```
 
 ### Endpoints
- 
+
+An instance of `NewsApiClient` has three instance methods corresponding to three News API endpoints.
+
 #### Top Headlines
 
+Use `.get_top_headlines()` to pull from the [`/top-headlines`](https://newsapi.org/docs/endpoints/top-headlines) endpoint:
+
 ```python
 api.get_top_headlines(sources='bbc-news')
 ```
+
 #### Everything
 
+Use `.get_everything()` to pull from the [`/everything`](https://newsapi.org/docs/endpoints/everything) endpoint:
+
 ```python
 api.get_everything(q='bitcoin')
 ```
+
 #### Sources
 
+Use `.get_sources()` to pull from the [`/sources`](https://newsapi.org/docs/endpoints/sources) endpoint:
+
 ```python
 api.get_sources()
 ```
@@ -64,7 +82,10 @@ You will encounter an error if you attempt to print the .json() object to the co
 This becomes especially annoying if developers wish to get 'under the hood'.
 
 Here is the error:
-    UnicodeEncodeError: 'charmap' codec can't encode character '\u2019' in position 1444: character maps to <undefined>
+
+```
+UnicodeEncodeError: 'charmap' codec can't encode character '\u2019' in position 1444: character maps to <undefined>
+```
 
 This can be fixed by:
     - installing 'win-unicode-console'
@@ -73,7 +94,7 @@ This can be fixed by:
         `py -mrun myPythonScript.py`
 
 Another option is hardcoding your console to only print in utf-8. This is a bad idea, as it could ruin many other scripts and/or make errors MUCH more difficult to track.
-[More information](https://stackoverflow.com/questions/5419/python-unicode-and-the-windows-console/32176732#32176732
+[More information](https://stackoverflow.com/questions/5419/python-unicode-and-the-windows-console/32176732#32176732).
 
 
 ## Support