Merge pull request #2514 from swetashre/readme

Update readme and add code_of_conduct

CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
+

README.rst

@@ -29,13 +29,27 @@ services that are supported.
     :target: https://github.com/boto/boto3/blob/develop/LICENSE
     :alt: License
 
-Quick Start
------------
-First, install the library and set a default region:
+Getting Started
+---------------
+Assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this or you can install the library using ``pip``:
+
+.. code-block:: sh
+
+    $ git clone https://github.com/boto/boto3.git
+    $ cd boto3
+    $ virtualenv venv
+    ...
+    $ . venv/bin/activate
+    $ pip install -r requirements.txt
+    $ pip install -e .
 
 .. code-block:: sh
 
     $ pip install boto3
+    
+Using Boto3
+~~~~~~~~~~~~~~
+After installing boto3 
 
 Next, set up credentials (in e.g. ``~/.aws/credentials``):
 
@@ -49,8 +63,10 @@ Then, set up a default region (in e.g. ``~/.aws/config``):
 
 .. code-block:: ini
 
-    [default]
-    region=us-east-1
+   [default]
+   region=us-east-1
+    
+Other credentials configuration method can be found `here <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html>`__
 
 Then, from a Python interpreter:
 
@@ -61,24 +77,6 @@ Then, from a Python interpreter:
     >>> for bucket in s3.buckets.all():
             print(bucket.name)
 
-Development
------------
-
-Getting Started
-~~~~~~~~~~~~~~~
-Assuming that you have Python and ``virtualenv`` installed, set up your
-environment and install the required dependencies like this instead of
-the ``pip install boto3`` defined above:
-
-.. code-block:: sh
-
-    $ git clone https://github.com/boto/boto3.git
-    $ cd boto3
-    $ virtualenv venv
-    ...
-    $ . venv/bin/activate
-    $ pip install -r requirements.txt
-    $ pip install -e .
 
 Running Tests
 ~~~~~~~~~~~~~
@@ -100,17 +98,6 @@ You can also run individual tests with your default Python version:
 
     $ nosetests tests/unit
 
-Generating Documentation
-~~~~~~~~~~~~~~~~~~~~~~~~
-Sphinx is used for documentation. You can generate HTML locally with the
-following:
-
-.. code-block:: sh
-
-    $ pip install -r requirements-docs.txt
-    $ cd docs
-    $ make html
-
 
 Getting Help
 ------------
@@ -123,3 +110,18 @@ help:
 * Come join the AWS Python community chat on `gitter <https://gitter.im/boto/boto3>`__
 * Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
 * If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/boto3/issues/new>`__
+
+
+Contributing
+------------
+
+We value feedback and contributions from our community. Whether it's a bug report, new feature, correction, or additional documentation, we welcome your issues and pull requests. Please read through this `CONTRIBUTING <https://github.com/boto/boto3/blob/develop/CONTRIBUTING.rst>`__ document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your contribution.
+
+
+More Resources
+--------------
+
+* `NOTICE <https://github.com/boto/boto3/blob/develop/NOTICE>`__
+* `Changelog <https://github.com/boto/boto3/blob/develop/CHANGELOG.rst>`__
+* `License <https://github.com/boto/boto3/blob/develop/LICENSE.txt>`__
+

docs/README.rst

@@ -0,0 +1,14 @@
+# Boto3 Documentation
+
+Documentation for boto3 can be found [here](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html)
+
+Generating Documentation
+~~~~~~~~~~~~~~~~~~~~~~~~
+Sphinx is used for documentation. You can generate HTML locally with the
+following:
+
+.. code-block:: sh
+
+    $ pip install -r requirements-docs.txt
+    $ cd docs
+    $ make html