Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmdrz committed Jan 27, 2019
1 parent 994aa02 commit aea1efd
Showing 1 changed file with 29 additions and 83 deletions.
112 changes: 29 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
# GoInsta. Make Goinsta Great Again!
### Go + Instgaram API
<p align="center"><img width=100% src="https://raw.githubusercontent.com/ahmdrz/goinsta/v1/resources/goinsta-image.png"></p>

> Unofficial Instagram API for Golang
[![Build Status](https://travis-ci.org/ahmdrz/goinsta.svg?branch=master)](https://travis-ci.org/ahmdrz/goinsta) [![GoDoc](https://godoc.org/github.com/ahmdrz/goinsta?status.svg)](https://godoc.org/github.com/ahmdrz/goinsta) [![Go Report Card](https://goreportcard.com/badge/github.com/ahmdrz/goinsta)](https://goreportcard.com/report/github.com/ahmdrz/goinsta) [![Coverage Status](https://coveralls.io/repos/github/ahmdrz/goinsta/badge.svg?branch=master)](https://coveralls.io/github/ahmdrz/goinsta?branch=master)
[![GoDoc](https://godoc.org/github.com/ahmdrz/goinsta?status.svg)](https://godoc.org/github.com/ahmdrz/goinsta) [![Go Report Card](https://goreportcard.com/badge/github.com/ahmdrz/goinsta)](https://goreportcard.com/report/github.com/ahmdrz/goinsta)

## Versioning

Goinsta used gopkg.in as versioning control. Stable new API is the version v2.0. You can get it using:
```bash
go get -u -v gopkg.in/ahmdrz/goinsta.v2
```
## Features
### Features

* **HTTP2 by default. Goinsta uses HTTP2 client enhancing performance.**
* **Object independency. Can handle multiple instagram accounts.**
Expand All @@ -21,30 +15,18 @@ go get -u -v gopkg.in/ahmdrz/goinsta.v2
* **Security**. Your password is only required to login. After login your password is deleted.
* **No External Dependencies**. GoInsta will not use any Go packages outside of the standard library.

## New Version !

We are working on a new object-oriented API. Try it and tell us your suggestions. See https://github.com/ahmdrz/goinsta/blob/master/CONTRIBUTING.md

If you want to use the old version you can found it in v1 branch or using gopkg.in/ahmdrz/goinsta.v1/

Sorry for breaking dependences :(. You can use this command in your project folder to update old master branch to v1.

```bash
for i in `grep -r ahmdrz ./ | awk '{split($0, a, ":"); print a[1]}'`; do sed -i 's/github\.com\/ahmdrz\/goinsta/gopkg\.in\/ahmdrz\/goinsta\.v1/g' $i; done
```

## Package installation
### Package installation

`go get -u -v gopkg.in/ahmdrz/goinsta.v2`

## CLI installation
### CLI installation

```
go get -u -v gopkg.in/ahmdrz/goinsta.v2
go install gopkg.in/ahmdrz/goinsta.v2/goinsta
```

## Example
### Example

```go
package main
Expand Down Expand Up @@ -76,7 +58,7 @@ func main() {

* [**More Examples**](https://github.com/ahmdrz/goinsta/tree/master/examples)

## Projects using Goinsta
### Projects using `goinsta`

- [icrawler](https://github.com/themester/icrawler)
- [go-instabot](https://github.com/tducasse/go-instabot)
Expand All @@ -85,12 +67,32 @@ func main() {
- [goinstadownload](https://github.com/alejoloaiza/goinstadownload)
- [instafeed](https://github.com/falzm/instafeed)
- [keepig](https://github.com/seankhliao/keepig)
- ...

## Legal
### Legal

This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by Instagram or any of its affiliates or subsidiaries. This is an independent and unofficial API. Use at your own risk.

## Donate
### Versioning

Goinsta used gopkg.in as versioning control. Stable new API is the version v2.0. You can get it using:
```bash
go get -u -v gopkg.in/ahmdrz/goinsta.v2
```

### New version !

We are working on a new object-oriented API. Try it and tell us your suggestions. See https://github.com/ahmdrz/goinsta/blob/master/CONTRIBUTING.md

If you want to use the old version you can found it in v1 branch or using gopkg.in/ahmdrz/goinsta.v1/

Sorry for breaking dependences :(. You can use this command in your project folder to update old master branch to v1.

```bash
for i in `grep -r ahmdrz ./ | awk '{split($0, a, ":"); print a[1]}'`; do sed -i 's/github\.com\/ahmdrz\/goinsta/gopkg\.in\/ahmdrz\/goinsta\.v1/g' $i; done
```

### Donate

**Ahmdrz**

Expand All @@ -101,61 +103,5 @@ This code is in no way affiliated with, authorized, maintained, sponsored or end
![btc](https://raw.githubusercontent.com/reek/anti-adblock-killer/gh-pages/images/bitcoin.png) Bitcoin: `37aogDJYBFkdSJTWG7TgcpgNweGHPCy1Ks`



[![Analytics](https://ga-beacon.appspot.com/UA-107698067-1/readme-page)](https://github.com/igrigorik/ga-beacon)


## Schema

The objects of the following schema can point to other objects defined below.

Instagram
- Account: Personal information and account interactions.
- Followers
- Following
- Feed
- FeedMedia
- Item(s)
- Stories
- StoryFeed
- Item(s)
- Liked
- FeedMedia
- Item(s)
- Saved
- SavedMedia
- Item(s)
- Tags
- FeedMedia
- Item(s)
- Blocked
- BlockedUser(s)
- Profiles: User interaction.
- Blocked
- BlockedUser(s)
- Get user using ID
- User
- Get user using Username
- User
- Media:
- Items
- Comments # Comments and Comment are different.
- User
- Comment(s) # Slice of Comment
- Likes
- Likers
- Item
- Items # If it is a carousel.
- Search:
- Location
- Username
- Tags
- Location **Deprecated**
- Facebook
- Activity:
- Following
- Recent
- Hashtag: Hashtag allows user to search using hashtags.
- Stories
- StoryMedia
- Media # By default hashtag contains Medias in the structure

0 comments on commit aea1efd

Please sign in to comment.