Skip to content

Update README.md w/ instructions/explanation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
levthedev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md w/ instructions/explanation #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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="<your access token>"``` 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!