Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikefowler committed Nov 5, 2013
1 parent 89ddb35 commit a38511d
Showing 1 changed file with 26 additions and 14 deletions.
40 changes: 26 additions & 14 deletions README.md
@@ -1,22 +1,34 @@
# Instajam

Instajam is a JavaScript wrapper for the Instagram API. You provide the access token, we provide the jam.
Instajam is a JavaScript wrapper for the Instagram API. You provide the access token, we provide the jam. (And Instagram provides the gram. Or the pictures. Or... whatever.)

## Basic Usage

``` javascript
// Initialize
API = Instajam.init({
clientId: '<CLIENT ID>',
redirectUri: '<REDIRECT URI>',
scope: ['basic', 'comments']
});

// Get the profile of the authenticated user.
API.user.self(function(response) {
console.log('Hey there, ' + response.data.full_name);
});
```

(And Instagram provides the gram. Or the pictures. Or... whatever.)
## Documentation

## Version History

* 2013/11/03 - Version 2.0.
- Now with 100% more version number!
- **The hard jQuery dependency is GONE.** Native JSONP request method implemented.
- Inline documentation via Docco
* 2012/09/10 - Version 1.0
- Initial release
- Supports all GET endpoints (does NOT include adding/removing comments or likes, or setting relationships)
Full documentation for Instajam can be found on the [project's homepage](http://mikefowler.me/instajam). [Inline documentation of the code](http://mikefowler.me/instajam/docco/instajam.html) (via Docco) is also available.

## Documentation
## Install via Bower

Documentation for Instajam can be found at the [project's homepage](http://mikefowler.me/instajam).
Instajam is available via the [Bower package manager](http://bower.io/):

``` bash
bower install instajam
```

## Contributing

Expand Down Expand Up @@ -54,4 +66,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THE SOFTWARE.

0 comments on commit a38511d

Please sign in to comment.