From aea1efdcd4c13b98b4256881837f1684c22b4462 Mon Sep 17 00:00:00 2001 From: Ahmadreza Zibaei Date: Sun, 27 Jan 2019 11:27:20 +0330 Subject: [PATCH] update README --- README.md | 112 ++++++++++++++---------------------------------------- 1 file changed, 29 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index af33d10d..42154073 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ -# GoInsta. Make Goinsta Great Again! +### Go + Instgaram API

> 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.** @@ -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 @@ -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) @@ -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** @@ -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