Work on README

README.md

@@ -1,40 +1,57 @@
-# Project Name
+# Bing Search Python SDK Samples
 
-(short, 1-3 sentenced, description of the project)
+These samples will show you how to get up and running using the Python SDKs for various Bing Search services. They'll cover a few rudimentary use cases and hopefully express best practices for interacting with the data from these APIs.
 
 ## Features
 
-This project framework provides the following features:
+This project framework provides examples for the following services:
 
-* Feature 1
-* Feature 2
-* ...
+* Using the **Bing Entity Search SDK** [azure-cognititiveservices-search-entitysearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-entitysearch) for the [Entity Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-entity-search-api/)
+* Using the **Bing Web Search SDK** [azure-cognititiveservices-search-entitysearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-entitysearch) for the [Web Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/)
+
+We provide several meta-packages to help you install several packages at a time. Please note that meta-packages are only recommended for development purpose. It's recommended in production to always pin specific version of individual packages.
 
 ## Getting Started
 
 ### Prerequisites
 
-(ideally very short, if any)
-
-- OS
-- Library version
-- ...
+1.  A cognitive services API key with which to authenticate the SDK's calls. [Sign up here](https://azure.microsoft.com/en-us/services/cognitive-services/directory/) by navigating to the **Search** services and acquiring an API key. You can get a trial key for **free** which will expire after 30 days.
 
 ### Installation
 
-(ideally very short)
+1.  If you don't already have it, [install Python](https://www.python.org/downloads/).
+
+    This sample (and the SDK) is compatible with Python 2.7, 3.3, 3.4, 3.5 and 3.6.
 
-- npm install [package name]
-- mvn install
-- ...
+2.  We recommend that you use a [virtual environment](https://docs.python.org/3/tutorial/venv.html)
+    to run this example, but it's not mandatory.
+    Install and initialize the virtual environment with:
+
+    ```
+    pip install virtualenv
+    virtualenv mytestenv
+    cd mytestenv
+    source bin/activate     # Linux shell (Bash, ZSH, etc.) only
+    ./scripts/activate      # PowerShell only
+    ./scripts/activate.bat  # Windows CMD only
+    ```
 
 ### Quickstart
-(Add steps to get up and running quickly)
 
-1. git clone [repository clone url]
-2. cd [respository name]
-3. ...
+1.  Clone the repository.
+
+    ```
+    git clone https://github.com/Azure-Samples/bing-search-python.git
+    ```
 
+2.  Install the dependencies using pip.
+
+    ```
+    cd bing-search-python
+    pip install -r requirements.txt
+    ```
+
+3.  Set up the environment variable SUBSCRIPTION_KEY with your CS key.
 
 ## Demo
 
@@ -48,10 +65,9 @@ To run the demo, follow these steps:
 2.
 3.
 
-## Resources
+To see the code of each example, simply look at the examples in the Samples folder. They are written to be isolated in scope so that you can see only what you're interested in.
 
-(Any additional resources or related projects)
+## Resources
 
-- Link to supporting information
-- Link to similar sample
-- ...
+- https://docs.microsoft.com/python/api/overview/azure/cognitive-services
+- https://github.com/Azure/azure-sdk-for-python

requirements.txt

@@ -1 +1,2 @@
-git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search&subdirectory=azure-cognitiveservices-search
+git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-entitysearch&subdirectory=azure-cognitiveservices-search-entitysearch
+git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-websearch&subdirectory=azure-cognitiveservices-search-websearch