Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yuvraj108c committed Jun 13, 2022
1 parent 6e224e0 commit ee914f5
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,33 @@

# Instagram Publisher

- Publish Instagram Images, Image Slideshows & Video Reels via NodeJS.
- Inspired by [instagram-web-api](https://www.npmjs.com/package/instagram-web-api)
- Publish Instagram Images, Slideshows & Video Reels via NodeJS.
- Supports cookies caching

## Install

```bash
npm install instagram-publisher
```

## Authentication
## Import

```js
import InstagramPublisher from 'instagram-publisher';
import InstagramPublisher from 'instagram-publisher'; // ES module

const InstagramPublisher = require('instagram-publisher'); // commonJS
```

## Authentication 🔒

```js
const client = new InstagramPublisher({
email: '[email protected]',
password: '12345',
});
```

## Create Image
## Create Image 🖼️

```js
const image_data = {
Expand All @@ -33,7 +39,7 @@ const image_data = {
const created = await client.createSingleImage(image_data);
```

## Create Image Slideshow
## Create Image Slideshow 🖼️🖼️🖼️

```js
const slideshow_data = {
Expand All @@ -43,7 +49,7 @@ const slideshow_data = {
const created = await client.createImageSlideshow(slideshow_data);
```

## Create Video Reel
## Create Video Reel 📷

```js
const video_data = {
Expand All @@ -55,7 +61,7 @@ const video_data = {
const created = await client.createSingleVideo(video_data);
```

## Important Notes
## Important Notes ⚠️

- Maximum images per slideshow: `10`
- Minimum images per slideshow: `2`
Expand All @@ -69,6 +75,10 @@ const created = await client.createSingleVideo(video_data);
- Cookies are cached under `cookies.json`
- Videos take some time to be published (< 60 seconds)

## Inspiration

- [instagram-web-api](https://www.npmjs.com/package/instagram-web-api)

## License

MIT

0 comments on commit ee914f5

Please sign in to comment.