ayadn 1.4.6 → 1.5.0

data/doc/06-post.md

@@ -0,0 +1,109 @@
+# POST
+
+Simple and fast way to post a short sentence/word to App.net.
+
+`ayadn post Hello from Ayadn`
+
+`ayadn -P Hello from Ayadn`
+
+`ayadn -P @ericd hello Eric`
+
+You have to put your text between single quotes if you're using punctuation:
+
+`ayadn -P 'Hello from Ayadn, guys!'`
+
+But remember you can't then use any `'` character!
+
+**So you should rather use either the _write_ or the _auto_ method for posting.**
+
+# WRITE
+
+Multi-line post to App.net.
+
+This is the recommended way to post elaborate text to ADN:
+
+`ayadn write`
+
+`ayadn -W`
+
+It will show you a prompt where you can type anything, including special characters and Markdown links.
+
+Hit ENTER to create line breaks and paragraphs.
+
+Cancel your post with CTRC-C or send it with CTRL-D.
+
+Just type a @username at the beginning of your post if you want to mention a specific user, as you would in any other App.net client.  
+
+# AUTO POST
+
+Auto post every line of input.
+
+The is the funniest way to post to ADN! :)  
+
+`ayadn auto`
+
+In this mode, each line you type (each time you hit ENTER!) is automatically posted to ADN.
+
+You can type anything, including special characters and Markdown links, and of course mention anyone: the only thing you can't do from this mode is _replying_ to a post in a thread.
+
+Hit CTRL+C to exit this mode at any moment.  
+
+# REPLY
+
+Reply to a specific post.
+
+- You can reply by specifying the post id:
+
+`ayadn reply 23362460`
+
+`ayadn -R 23362460`
+
+Ayadn will then show you the *write* prompt.
+
+If you reply to a post containing multiple mentions, your text will be inserted between the leading mention and the other ones.
+
+- You can also reply to the *index* of the post instead of its *id* _if you used the '--index' or '-i' option_ when previously viewing a stream:
+
+`ayadn -R 3`  
+
+# PM (PRIVATE MESSAGE)
+
+Send a private message to a specific user.
+
+`ayadn pm @ericd`
+
+Ayadn will then show you the *write* prompt.  
+
+# SEND
+
+Send a message to an App.net CHANNEL.
+
+`ayadn send 46217`
+
+`ayadn -C 46217`
+
+Ayadn will then show you the *write* prompt.
+
+If you've already created an [alias](#alias) for the channel, you can post to it with:
+
+`ayadn send mychannelalias`
+
+`ayadn -C mychannelalias`
+
+# EMBED PICTURES
+
+You can embed one or several pictures in a post (with `post`, `write`, `reply` and `pm`).
+
+Just add the `-e` (or `--embed`) option **at the end** of the command line, followed by one or several file paths separated by spaces.
+
+Accepted file formats are `jpg`, `png` and `gif`.
+
+Examples:
+
+```
+ayadn -P Meet my cat -e lolcat.jpg
+ayadn -P "@ericd Hey, meet my pets" -e ~/lolcat.jpg ./doge.jpeg
+ayadn -W -e ~/lolcat.png
+ayadn -R 23362460 -e "Desktop/dancing lolcat.gif"
+ayadn pm @ericd -e /users/dad/lol\'cat.JPG /users/mom/my\ doge.PNG
+```  

data/doc/07-actions.md

@@ -0,0 +1,115 @@
+# DELETE
+
+Delete a post.
+
+`ayadn delete 23365251`
+
+`ayadn -D 23365251`
+
+# DELETE MESSAGE
+
+Delete a message. 
+
+You have to specify channel id (or alias) then message number.
+
+`ayadn delete_m 42666 3365251`
+
+`ayadn -DM 42666 3365251`
+
+`ayadn -DM my_alias 3365251`
+
+# REPOST
+
+Repost a post.
+
+`ayadn repost 23365251`
+
+`ayadn -O 23365251`
+
+# UNREPOST
+
+Unrepost a post.
+
+`ayadn unrepost 23365251`
+
+`ayadn -UR 23365251`
+
+# STAR
+
+Star a post.
+
+`ayadn star 23365251`
+
+`ayadn -ST 23365251`
+
+# UNSTAR
+
+Unstar a post.
+
+`ayadn unstar 23365251`
+
+`ayadn -US 23365251`
+
+# FOLLOW
+
+Follow a user.
+
+`ayadn follow @ericd`
+
+`ayadn -FO @ericd`
+
+# UNFOLLOW
+
+Unfollow a user.
+
+`ayadn unfollow @ericd`
+
+`ayadn -UF @ericd`
+
+# MUTE
+
+Mute a user.
+
+`ayadn mute @spammer`
+
+`ayadn -MU @spammer`
+
+# UNMUTE
+
+Unmute a user.
+
+`ayadn unmute @spammer`
+
+`ayadn -UM @spammer`
+
+# BLOCK
+
+Block a user (same as mute but also prevents the blocked user to follow you).
+
+`ayadn block @spammer`
+
+`ayadn -BL @spammer`
+
+# UNBLOCK
+
+Unblock a user.
+
+`ayadn unblock @spammer`
+
+`ayadn -UB @spammer`
+
+# DOWNLOAD
+
+Download a file from your App.net storage (any file posted with other ADN clients).
+
+`ayadn download 23344556`
+
+`ayadn -df 23344556`
+
+# PIN
+
+Export a post's link and text, with tags, to your Pinboard account.
+
+`ayadn pin 22790201 Ayadn gem update`
+
+`ayadn pin 26874913 duel swords france`

data/doc/08-listings.md

@@ -0,0 +1,85 @@
+# FOLLOWERS
+
+List followers of a user.
+
+`ayadn followers @ericd`
+
+`ayadn -fwr @ericd`
+
+You can see your own list by using *me* instead of *@username*:
+
+`ayadn -fwr me`
+
+# FOLLOWINGS
+
+List the users a user is following.
+
+`ayadn followings @ericd`
+
+`ayadn -fwg @ericd`
+
+You can see your own list by using *me* instead of *@username*:
+
+`ayadn -fwg me`
+
+# CHANNELS
+
+List your active App.net channels.
+
+`ayadn channels`
+
+`ayadn -ch`
+
+# INTERACTIONS
+
+Shows a short reminder of your recent App.net activity.
+
+`ayadn interactions`
+
+`ayadn -int`
+
+# WHOREPOSTED
+
+List users who reposted a post.
+
+`ayadn whoreposted 22790201`
+
+`ayadn -wor 22790201`
+
+# MUTED
+
+List the users you muted.
+
+`ayadn muted`
+
+`ayadn -mtd`
+
+# BLOCKED
+
+List the users you blocked.
+
+`ayadn blocked`
+
+`ayadn -bkd`
+
+# SETTINGS
+
+List current Ayadn settings.
+
+`ayadn settings`
+
+`ayadn -sg`
+
+# FILES
+
+List the files in your App.net storage.
+
+`ayadn files`
+
+`ayadn -fl`
+
+List them all:
+
+`ayadn files -a`
+
+`ayadn -fl -a`

data/doc/09-accounts.md

@@ -0,0 +1,33 @@
+# AUTHORIZE
+
+Authorize Ayadn for a specific user account.
+
+`ayadn authorize`
+
+`ayadn -auth`
+
+Ayadn will give you a link leading to the official App.net registration page.
+
+After your successful login, you will be redirected to the Ayadn authorization page.
+
+Copy the code (token) you will find there and paste it into Ayadn: a new user will be created and automatically logged in.  
+
+# SWITCH
+
+Switch between your authorized accounts.
+
+`ayadn switch @ericd`
+
+`ayadn switch @otheraccount`
+
+Alternative syntax:
+
+`ayadn -@ ericd`
+
+`ayadn -@ otheraccount`
+
+List your authorized accounts:
+
+`ayadn switch -l`
+
+`ayadn -@ -l`

data/doc/10-nicerank.md

@@ -0,0 +1,58 @@
+# NiceRank
+
+[NiceRank](http://jasonirwin.ca/2014/05/14/thinking-about-nicerank/) is a filter provided by Jason Irwin.
+
+Thanks to this algorithm, you will be able to filter the spammers out of the Global stream!
+
+It provides a whole new experience of ADN, and brings you back the pleasure of discovering new people to follow.
+
+Ayadn is compatible with NiceRank since version 1.2.
+
+*NiceRank only works with the Global stream.*  
+
+## The scale
+
+NiceRank analyzes App.net users, applies filters then attributes the users a score from 0 to 5.
+
+*This is not a 'Klout' for ADN: NiceRank's only purpose is to differentiate spammers from regular users.*
+
+An idea of the scale:
+
+- A spammer's rank is always < 1
+
+- A user posting a lot of automated links without being active otherwise will be < 2
+
+- A new ADN user will typically start with 2
+
+- A regular user will always be > 2
+
+- Active regular users will be > 3
+
+- Very 'social' users can be > 4
+
+*Again, this is not a popularity ratio: far from it. It only serves as a filter for bots and spam.*
+
+
+## Activate NiceRank
+
+NiceRank is disabled by default.
+
+Enable it with:
+
+`ayadn set nicerank filter true`
+
+My advice is to also filter out the few users that NiceRank haven't analyzed yet, as most of them are bots:
+
+`ayadn set nicerank filter_unranked true`
+
+## Threshold
+
+Set the NiceRank threshold.
+
+Any user with a NiceRank smaller than this value will be ignored.
+
+`ayadn set nicerank threshold 2`  
+
+## Deactivate NiceRank
+
+It's the same as above, with *false* instead of *true*.  

data/doc/11-blacklist.md

@@ -0,0 +1,85 @@
+# BLACKLIST
+
+The blacklist is a list of users, clients and hashtags that you don't want to ever be displayed.
+
+Available subcommands: add, remove, import, list.
+
+This is different from the 'mute a user' feature of the App.net API: blacklist works locally and is specific to each account.
+
+Blacklist a client (example: IFTTT) and posts that are posted with this client won't appear in the streams.
+
+This is a way of creating "bot-free" streams: the more bots you add to this list, the more humans you see.
+
+Blacklist a hashtag and you will free yourself from this annoying trend you can't stand.
+
+Blacklist a user and you won't even see posts by other users mentioning the user you blacklisted!
+
+Oh, and you can import blacklist databases from other accounts, too.
+
+## ADD
+
+Adds an item to your blacklist.
+
+Available items: client, hashtag, mention.
+
+`ayadn blacklist add mention @shmuck`
+
+Add a mention:
+
+`ayadn -K add mention @shmuck`
+
+Add a client:
+
+`ayadn -K add client IFTTT`
+
+Add a hashtag:
+
+`ayadn -K add hashtag twitter`
+
+## REMOVE
+
+Removes an item from your blacklist.
+
+Available items: client, hashtag, mention.
+
+`ayadn blacklist remove mention @shmuck`
+
+Remove a mention:
+
+`ayadn -K remove mention @shmuck`
+
+Remove a client:
+
+`ayadn -K remove client IFTTT`
+
+Remove a hashtag:
+
+`ayadn -K remove hashtag twitter`
+
+## LIST
+
+List all items in your blacklist.
+
+`ayadn blacklist list`
+
+`ayadn -K list`
+
+## IMPORT
+
+Import a blacklist database in the current account.
+
+`ayadn blacklist import '/Users/blah/backups/blacklist.db'`
+
+`ayadn -K import '/Users/blah/backups/blacklist.db'`
+
+## MULTIPLE TARGETS
+
+You can add/remove several elements to/from the blacklist at once.
+
+(For usernames, '@' prefix will automatically be added if missing.)  
+
+`ayadn -K add mention shmuck jerk mrspammer`
+
+`ayadn -K add client ifttt pourover twitterfeed`
+
+`ayadn -K add hashtag twitter facebook instagram`