		@@ -1,4 +0,80 @@
		# node-twitter-es6
		Twitter API for Node.js / io.js written in ECMAScript 6
		# easy-twitter
		A basic Twitter API for Node.js / io.js written in ECMAScript 6.
		Follow, unfollow, tweet, get infos about a twitter account and more ...

		Documentation here: https://github.com/Pandazaur/node-twitter-es6/wiki
		### Getting started
		When you have installed and include this twitter module, you have to create a new instance:

		```javascript
		var twitter = new TwitterClient({consumer_key: "xxxx",
		consumer_secret: "yyyy",
		access_token_key: "zzzz",
		access_token_secret : "aaaa"});
		```
		___
		### Usage
		#### Create a tweet (message)
		If you want to tweet a message you can use the method `Twitter.tweet()`. This method returns a promise with the `message` in parameter when succeed.

		```javascript
		var message = 'Hello world !';
		twitter.tweet(message)
		.then(function(data) {
		//_Successfully tweet the message
		console.log('Posted the tweet:' + data.tweet);
		})
		.catch(function(err) {
		//_If failed to tweet
		console.log(err.error);
		});
		```

		#### Create a tweet with image
		The first parameter is the `message` you want to post and the second parameter is the `path` to the image that you want to post.

		```javascript
		var message = 'I like Twitter !';
		var path = '/foo/bar/image.png';

		twitter.uploadMedia(message, path)
		.then(function(data) {
		console.log('Tweeted the message: ' + data.message);
		})
		.catch(function(err) {
		console.log(err.error);
		});
		```

		#### Follow a twitter account
		You can follow someone with the method `follow()` with the `name` of the twitter account in parameter. You can pass in parameter the name of the account with or without the '@'.

		```javascript
		//_Both the variables are correct
		var twitterAccount = 'iAmAlphaZz'
		var secondTwitterAccount = '@iAmAlphaZz'

		twitter.follow(twitterAccount)
		.then(function(data) {
		console.log('You\'re now following :' + data.user);
		})
		.catch(function(err) {
		console.log(err.error);
		});
		```

		#### Unfollow a twitter account
		The `unfollow()` method is used like the `follow()` method: you just have to pass in parameter the name of the twitter account.

		```javascript
		//_Both the variables are correct
		var twitterAccount = 'iAmAlphaZz'
		var secondTwitterAccount = '@iAmAlphaZz'

		twitter.unfollow(twitterAccount)
		.then(function(data) {
		console.log('You\'re now following :' + data.user);
		})
		.catch(function(err) {
		console.log(err.error);
		});
		```

easy-twitter - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics