From e47ac86e4a79044cd26d397898b085ec697fe848 Mon Sep 17 00:00:00 2001 From: Lev Kravinsky Date: Sat, 20 Jun 2015 21:18:18 -0600 Subject: [PATCH] Update README.md Added instructions on what the extension does and how to use/upload it locally. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e3d19e..814d557 100644 --- a/README.md +++ b/README.md @@ -1 +1,8 @@ -An example Chrome extension for interacting with the [Genius API](http://genius.com/developers). +###Chrome Extension Overview +This is an example Chrome extension for interacting with the [Genius API](http://genius.com/developers). It adds functionality to Chrome's Omnibox (the search bar) that allows users to type the keyword 'Genius' followed by any query. This returns search results of the query from Genius in the suggestion dropdown of Chrome's Omnibox. + +###Usage +To use this extension, simply sign up for the [Genius API](http://genius.com/developers). Once you are signed up, replace ```var accessToken=""``` with the access token that you are given by Genius. To test this chrome extension out locally, you need to go to your Chrome Extensions and enable "Developer Mode". Then click "Load unpacked extension" and select the folder you cloned this repository into. Now, try typing a query after the keyword "Genius", such as "Genius kanye west". + +###What next? +You can use this as an intro to using the Genius API and to writing Chrome Extensions. Maybe you want to make an app that finds and flags songs on Genius without annotations, or an app that alerts you whenever a presidential candidate makes a speech so that you can annotate it. Perhaps you'd like a Chrome extension that allows you to easily create a list of favorite songs that when clicked, brings up their Genius pages, or an extension that automatically uploads a poem every day to Genius. Whatever it is you'd like to create, go forth and create it!