瀏覽代碼

Adding images to API examples in README

David Leonard 10 年之前
父節點
當前提交
32b1061a99
共有 1 個文件被更改,包括 84 次插入51 次删除
  1. 84 51
      README.md

+ 84 - 51
README.md

@@ -31,7 +31,7 @@ Features
 * User Registration
 * Basic Authentication with username and password
 * **OAuth 2.0 Authentication** for Github, LinkedIn and Instagram
-* **OAuth 1.0a Authentication** for Twitter and Tumblr.
+* **OAuth 1.0a Authentication** for Twitter and Tumblr
 * API Examples
     * Yelp API
     * Github API
@@ -45,34 +45,42 @@ Features
     * New York Times API
     * LinkedIn API
 
+<hr>
+
 
 Getting Started
 ---------------
 To get up and running, simply do the following:
 
-    git clone https://github.com/DrkSephy/django-hackathon-starter.git
-    cd django-hackathon-starter
+    $ git clone https://github.com/DrkSephy/django-hackathon-starter.git
+    $ cd django-hackathon-starter
+    
     # Install the requirements
-    pip install -r requirements.txt
+    $ pip install -r requirements.txt
+    
     # Install bower
-    npm install -g bower
-    bower install
-    mv bower_components/ hackathon_starter/hackathon/static
+    $ npm install -g bower
+    $ bower install
+    $ mv bower_components/ hackathon_starter/hackathon/static
+    
     # Perform database migrations
-    python manage.py makemigrations
-    python manage.py migrate
+    $ python manage.py makemigrations
+    $ python manage.py migrate
 
 **NOTE**: We highly recommend creating a [Virtual Environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/). Python Virtual Environments allow developers to work in isolated sandboxes and to create separation between python packages installed via pip.
 
 **NOTE**: To get you up and running quickly, we have provided dummy API keys for use. We highly recommend setting up your own keys and replacing them within `settings.py`. 
 
+
+<hr>
     
 Getting API Keys
 ----------------
-# Yelp #
+
+<img src="https://rentpost.com/blog/wp-content/uploads/2015/01/yelp.png" width="200">
 
 1. Register an account on [Yelp.com](http://www.yelp.com/)
-2. Visit the [Yelp for developers page](https://www.yelp.com/developers/manage_api_keys).
+2. Visit the [Yelp for developers page](https://www.yelp.com/developers/manage_api_keys)
 3. You will obtain the following: `CONSUMER KEY`, `CONSUMER SECRET`, `TOKEN`, `TOKEN_SECRET`
 4. Within `settings.py`, add the following:
     * `YELP_CONSUMER_KEY` = `Yelp Consumer Key`
@@ -80,17 +88,21 @@ Getting API Keys
     * `YELP_TOKEN` = `Yelp Token`
     * `YELP_TOKEN_SECRET` = `Yelp Token Secret`
 
-# Meetup #
+<hr>
+
+<img src="https://lh5.ggpht.com/4RfLjWcvlfdFWfxeDcpZxJLWhDytkQhQd2qLSqMhForQoILXf9HqmMD6DNmpbzJzaQ=w300" width="200">
 
 1. Register an account on [Meetup.com](http://www.meetup.com/)
 2. Visit [Meetup OAuth Consumers page](https://secure.meetup.com/meetup_api/oauth_consumers/)
-    * Enter a project name for the `consumer name` field.
+    * Enter a project name for the `consumer name` field
     * For `redirect url` field, enter: `http://127.0.0.1:8000/hackathon/`
 3. Within `settings.py`, add the following:
     * `MEETUP_CONSUMER_KEY` = `Meetup key`
     * `MEETUP_CONSUMER_SECRET` = `Meetup secret key` 
 
-# Twilio 
+<hr>
+
+<img src="https://tctechcrunch2011.files.wordpress.com/2012/11/twilio-logo-6a141664f35a78e9ac08eed627c2a859.png" width="300">  
 
 1. Register an account on [Twilio.com](https://www.twilio.com/)
 2. Get your [Twilio Number](https://www.twilio.com/user/account/phone-numbers/incoming)
@@ -100,7 +112,9 @@ Getting API Keys
     * Replace `account_sid` with your own Twilio `account_sid`
     * Replace `auth_token` with your own Twilio `auth_token`
 
-# Github #
+<hr>
+
+<img src="http://3.bp.blogspot.com/-gSyd39LDMRk/TzpVnaZ7ELI/AAAAAAAAEfg/9w1iB-mn5ZM/s1600/github-socialcoding-logo.png" width="300">
 
 1. Register an account on [Github.com](http://www.github.com/).
 2. Visit [Github developer applications page](https://github.com/settings/developers)
@@ -112,79 +126,98 @@ Getting API Keys
     * `GITHUB_CLIENT_ID` = `Github-client-id`
     * `GITHUB_CLIENT_SECRET` = `Github-client-secret`
 
-# Twitter #
+<hr>
 
-1. Register an account on [Twitter.com](http://www.twitter.com/).
+<img src="https://g.twimg.com/Twitter_logo_blue.png" width="100">
+
+1. Register an account on [Twitter.com](http://www.twitter.com/)
 2. Visit [Twitter application management page](https://apps.twitter.com/)
-3. Click on **Create New App**.
-    * Enter `Application name`, `Description`, and `Website` field.
+3. Click on **Create New App**
+    * Enter `Application name`, `Description`, and `Website` field
     * For `Callback URL` field, enter: `http://127.0.0.1:8000/hackathon/`
-4. Click **Create your Twitter application**.
-5. Go to the **Permissions** tab.
-6. Under *Access*, select **Read and Write* type.
-7. Go to **Keys and Access Tokens ** tab.
-8. Under *Your Access Token*, click on **Create my access token** to generate access tokens.
+4. Click **Create your Twitter application**
+5. Go to the **Permissions** tab
+6. Under *Access*, select **Read and Write** type
+7. Go to **Keys and Access Tokens** tab
+8. Under *Your Access Token*, click on **Create my access token** to generate access tokens
 9. Within `settings.py`, add the following:
     * `TWITTER_CONSUMER_KEY` = `Twitter-consumer-key`
     * `TWITTER_CONSUMER_SECRET` = `Twitter-consumer-secret`
     * `TWITTER_ACCESS_TOKEN` = `Twitter-access-token`
     * `TWITTER_ACCESS_TOKEN_SECRET` = `Twitter-access-token-secret`
 
-# Instagram #
+<hr>
+
+<img src="http://thinkpynk.com/wp-content/uploads/2015/04/instagram-logo.png" width="200">
 
 1. Register an account on [Instagram.com](http://www.instagram.com/).
-2. Visit [Instagram manage clients page](https://instagram.com/developer/clients/manage/).
-3. Click on **Register a New Client**.
-    * Enter `Application name`, `Description`, and `Website URL` field.
-    * For `Redirect URI` field, enter: `http://127.0.0.1:8000/hackathon/`.
+2. Visit [Instagram manage clients page](https://instagram.com/developer/clients/manage/)
+3. Click on **Register a New Client**
+    * Enter `Application name`, `Description`, and `Website URL` field
+    * For `Redirect URI` field, enter: `http://127.0.0.1:8000/hackathon/`
 4. Within `settings.py`, add the following:
     * `INSTAGRAM_CLIENT_ID` = `Instagram-client-id`
     * `INSTAGRAM_CLIENT_SECRET` = `Instagram-client-secret`
 
-# LinkedIn #
+
+<hr>
+
+<img src="http://blogs.kenan-flagler.unc.edu/wp-content/uploads/2013/10/LinkedIn-Logo-2C.png" width="200">
 
 1. Register an account on [Linkedin.com](http://www.linkedin.com/).
-2. Visit [Linkedin developer Network page](https://www.linkedin.com/secure/developer).
-3. Click on **Add New Application**.
-    * Enter `Company Info`, `Application Info`, and `Contact Info` section.
-    * Under `OAuth User Agreement` section, select scopes needed.
-    * For `OAuth 2.0 Redirect URLs` field, enter: `http://127.0.0.1:8000/hackathon/`.
-4. Click **Add Application**.
+2. Visit [Linkedin developer Network page](https://www.linkedin.com/secure/developer)
+3. Click on **Add New Application**
+    * Enter `Company Info`, `Application Info`, and `Contact Info` section
+    * Under `OAuth User Agreement` section, select scopes needed
+    * For `OAuth 2.0 Redirect URLs` field, enter: `http://127.0.0.1:8000/hackathon/`
+4. Click **Add Application**
 5. Within `settings.py`, add the following:
     * `LINKEDIN_CLIENT_ID` = `Linkedin-client-id`
     * `LINKEDIN_CLIENT_SECRET` = `Linkedin-client-secret`
 
-# Facebook #
+<hr>
+
+<img src="http://www.freelargeimages.com/wp-content/uploads/2014/11/Facebook_logo-6.jpg" width="200">
 
-1. Register an account on [Facebook.com](http://www.facebook.com.com/).
-2. Visit [Facebook Developer Network page](https://developers.facebook.com/).
-3. After logging in, Click on **My Apps** and then on **Add a New App+**.
-    * Choose Website as the platform and add the **name** for your project.
+1. Register an account on [Facebook.com](http://www.facebook.com.com/)
+2. Visit [Facebook Developer Network page](https://developers.facebook.com/)
+3. After logging in, Click on **My Apps** and then on **Add a New App+**
+    * Choose Website as the platform and add the **name** for your project
     * Click on **Create New Facebook APP ID** and choose the **Category** of your application
     * Click **Create App ID**
-4. After the captcha, scroll down past the quick start and add `http://localhost:8000/`.
+4. After the captcha, scroll down past the quick start and add `http://localhost:8000/`
 5. Within your `views.py` add the **App ID** in `yourappid` underneath the view for your facebook application.
 
-# Steam #
 
-1. Register an account on [Steam](https://store.steampowered.com/join/).
-2. Visit [Steam Community developers page](https://steamcommunity.com/login/home/?goto=%2Fdev%2Fapikey).
-3. After logging in, add the **Domain Name** as the name of your application and **key** is shown.
-4. Within your `views.py` add the **Key** in `key` underneath the view for your steam application.
+<hr>
+
+<img src="http://games.overpress.it/wp-content/uploads/sites/7/2014/10/steam-logo-10.jpg" width="200">
+
+1. Register an account on [Steam](https://store.steampowered.com/join/)
+2. Visit [Steam Community developers page](https://steamcommunity.com/login/home/?goto=%2Fdev%2Fapikey)
+3. After logging in, add the **Domain Name** as the name of your application and **key** is shown
+4. Within your `views.py` add the **Key** in `key` underneath the view for your steam application
 
-# NY Times #
 
-1. Register an account on [NY Times Developer Network](http://developer.nytimes.com/docs).
+<hr>
+
+<img src="http://upload.wikimedia.org/wikipedia/commons/7/77/The_New_York_Times_logo.png" width="200">
+
+1. Register an account on [NY Times Developer Network](http://developer.nytimes.com/docs)
 2. Click on [Register](https://myaccount.nytimes.com/register)
-3. After logging in, click on **APIs** (http://developer.nytimes.com/apps/register).
+3. After logging in, click on **APIs** (http://developer.nytimes.com/apps/register)
     Write in the **Name** of your application and click each **sub-API** that you will use
     * Agree to the **Terms of Service** and click on **Register Application**
 4. Within your `settings.py` add the following:
     * `POPAPIKEY` = `Most Popular API`
     * `TOPAPIKEY` = `Top Stories API`
 
-# Quandl #
+<hr>
+
+<img src="http://planetcassandra.org/blogs/Upload/Postddfdbb6f-16ed-4e1c-8e29-ff2cf0cb43a1/quandl.png" width="200">
 
 1. Register an account on [Quandl](https://www.quandl.com/)
 2. After logging in, click on **Me** and then **Account settings** to find the API key 
 3. Within your `settings.py`add `QUANDLAPIKEY` = `Key` 
+
+