ayadn 0.6.4 → 1.0.0

data/README.md

@@ -1,440 +1,55 @@
+[![Build Status](https://travis-ci.org/ericdke/na.svg?branch=master)](https://travis-ci.org/ericdke/na)
+
 AYADN
 =====
 
-[App.net](http://app.net) command-line client developed in Ruby.
-
-[![Gem Version](https://badge.fury.io/rb/ayadn.png)](http://badge.fury.io/rb/ayadn)
-
-- [FEATURES](#features)
-- [TL;DR](#tldr)
-- [IMPORTANT NOTE](#important-note)
-- [INSTALL](#install)
-- [HOW TO USE](#how-to-use)
-- [LIST OF COMMANDS](#list-of-commands)
-- [TIPS](#tips)
-	- [Skip specific posts](#skip-specific-posts)
-	- [Backup some data](#backup-some-data)
-	- [Post links](#post-links)
-	- [Reset pagination data](#reset-pagination-data)
-	- [Custom posts count](#custom-posts-count)
-	- [Pinboard](#pinboard)
-	- ["me"](#me)
-	- [Shortcuts](#shortcuts)
-	- [Channels](#channels)
-	- [Just for fun](#just-for-fun)
-- [HELP](#help)
-	- [Console](#console)
-	- [Database](#database)
-- [CONTACT](#contact)
-- [CREDITS](#credits)
-	- [Beta-testers](#beta-testers)
-
-## FEATURES
-
-- read/scroll your App.net stream
-
-- write a post
-
-- reply to a post 
-
-- read the conversation around a post
-
-- star/unstar a post
-
-- repost/unrepost a post
-
-- quote a post
-
-- send a private message
-
-- read your private messages
-
-- follow/unfollow a user
-
-- ask if a user follows another one
-
-- mute/unmute a user
-
-- search posts for word(s)
-
-- search posts with hashtag
-
-- get informations on a post/user
-
-- read/scroll posts from a user
-
-- read/scroll posts mentioning a user
-
-- read posts starred by a user
-
-- see users who starred/reposted a post
-
-- read/scroll other streams: "checkins", "global", "trending", "conversations"
-
-- read a timeline of your interactions
-
-- delete a post/message
-
-- save/load a post locally
+[App.net](http://app.net) command-line client.
 
-- backup/display your lists of followings, followers, muted users...
+The purpose of Ayadn is to give you access to all the features of App.net from the command line.
 
-- create links with Markdown in your text
+View or scroll all streams, view or scroll conversations and posts from specific users or mentioning a user, follow/unfollow users, star/unstar/repost/etc, get information about users and their followers/followings, search for words or hashtags, list and download your files, view all your channels including Broadcasts and Patter rooms, write single-line or multi-line posts, send private messages, view geolocation data, etc.
 
-- skip posts from specific client (like IFTTT, PourOver, etc)
+More than 50 features await for your Geekiness to command them.
 
-- skip posts containing specific #hashtag
+Ayadn is configurable: colors, timelines, durations, aliases, etc. 
 
-- skip posts containing specific @username
+You can also specify many options from the commande line, like show the raw JSON instead of the formatted response, show only a number of most recents posts, show only new posts, etc.
 
-- list, download, delete files from your ADN account
+There's also exclusive features, like the Blacklist: feed this mini database with usernames, client names or hashtags and Ayadn will never show you any post containing any of these elements.
 
-- change file attribute: public/private
+Last but not least: Ayadn supports multi-accounting! Authorize as many accounts as you wish and simply switch between them with a keystroke.  
 
-- upload files to your ADN account *(only OS X and Linux)*
-
-- list your subscribed channels
-
-- post to your subscribed channels
-
-- save a post link to your Pinboard account
-
-- post the current iTunes song with #nowplaying hashtag *(only OS X)*
-
-- [and more!](https://github.com/ericdke/ayadn#list-of-commands)
-
-*There's also a [landing page](http://ayadn-app.net) and, of course, the [blog](http://ayadn.re-app.net).*  
-
-## TL;DR
-
-```
-gem install ayadn
-ayadn authorize
-ayadn write 'Posting to App.net with Ruby!'
-``` 
-
-## IMPORTANT NOTE
-
-Ayadn is currently in a transition process from beta to v1.
-
-The current [na](https://github.com/ericdke/na) repository will become Ayadn v1 when ready and complete (multi account, automatic initial configuration, configuration with ayadn commands, modular code, OSS rules compliant, new layout, new features, new options, etc).
 
 ## INSTALL
 
-In your console/terminal:
-
-```
-gem install ayadn
-```  
-
-## HOW TO USE
-
-You have to authorize Ayadn to use your App.net credentials.
-
-*Just run Ayadn to start the process!*
-
-**`ayadn` + optional action + optional target(s) + optional value(s)**
-
-If you don't provide any option to Ayadn, your personnalized stream is displayed.
-
-By default, Ayadn displays only the new posts in the stream since your last visit.  
-
-**I strongly recommend you run this command after install:**
-
-`ayadn install config`
-
-**so that you can then customize the `~/ayadn/data/config.yml` file this command will create.**
-
-*Note: Ayadn will try and use your existing authorization if you had a previous version installed. If it fails, just run `ayadn authorize` again.*
-
-## LIST OF COMMANDS
-
-*Only the first lines include the `[PRESS ENTER KEY]` reminder for obvious readability reasons.*
-
-```
-ayadn [PRESS ENTER KEY] 
-ayadn scroll [PRESS ENTER KEY]
-ayadn write [PRESS ENTER KEY] 
-ayadn write '@ericd Good morning Eric!' [PRESS ENTER KEY]
-ayadn reply 18527205 [PRESS ENTER KEY] 
-ayadn pm @ericd [PRESS ENTER KEY] 
-ayadn global
-ayadn scroll global
-ayadn checkins
-ayadn scroll checkins
-ayadn trending
-ayadn scroll trending
-ayadn photos
-ayadn scroll photos
-ayadn conversations
-ayadn scroll conversations
-ayadn mentions @ericd
-ayadn scroll mentions @ericd
-ayadn posts @ericd
-ayadn scroll posts @ericd
-ayadn starred @ericd
-ayadn starred 18527205
-ayadn reposted 18527205
-ayadn infos @ericd
-ayadn infos 18527205
-ayadn convo 15726105
-ayadn tag nowplaying
-ayadn follow @ericd
-ayadn unfollow @ericd
-ayadn mute @ayaio
-ayadn unmute @ayaio
-ayadn block @spammer
-ayadn unblock @spammer
-ayadn nowplaying
-ayadn interactions
-ayadn list files
-ayadn list files all
-ayadn download 286458
-ayadn download 286458,286797
-ayadn upload /path/to/kitten.jpg
-ayadn private 286458
-ayadn public 286458
-ayadn delete-file 286458
-ayadn search ruby
-ayadn search ruby,json
-ayadn channels
-ayadn send 12345
-ayadn messages 12345
-ayadn messages 12345 all
-ayadn star 18527205
-ayadn unstar 18527205
-ayadn repost 18527205
-ayadn unrepost 18527205
-ayadn quote 18527205
-ayadn delete 12345678
-ayadn delete-message 12345 23456789
-ayadn list muted
-ayadn list followings @ericd
-ayadn list followers @ericd
-ayadn backup muted
-ayadn backup followings @ericd
-ayadn backup followers @ericd
-ayadn save 18527205
-ayadn load 18527205
-ayadn skip-source add IFTTT
-ayadn skip-source remove IFTTT
-ayadn skip-source show
-ayadn skip-tag add sports
-ayadn skip-tag remove sports
-ayadn skip-tag show
-ayadn skip-mention add username
-ayadn skip-mention remove username
-ayadn skip-mention show
-ayadn pin 16864003 ruby,json
-ayadn alias-channel 12345 channel_name
-ayadn messages channel_name
-ayadn list alias
-ayadn unified 10
-ayadn global 10
-ayadn checkins 10
-ayadn photos 10
-ayadn trending 10
-ayadn conversations 10
-ayadn mentions @ericd 10
-ayadn posts @ericd 10
-ayadn starred @ericd 10
-ayadn does @ericd follow @ayadn
-ayadn reset pagination
-ayadn list options
-ayadn help
-ayadn commands
-ayadn webhelp
-ayadn random
-```  
-
-## HELP
-
-### Writing in the console/terminal
-
-Be aware of the way the console/terminal treats what you type if you're using ayadn inline, like this: `ayadn write "Hello"`
-
-When posting with `"double quotes"`, any special character will be interpreted by the command line! 
-
-So you have to post with `'simple quotes'` instead, this way the console don't mess with your content.
-
-But it creates other problems...
-
-**My advice: post with the compose feature, that is to say without providing your text inline:**  
-  
-`ayadn write`  
-
-Then just write your text, nothing else is needed, no single or double quotes.
-
-### Database
-
-Ayadn keeps a database of the ids of all the users it sees (it reduces the number of API calls and speeds up the app.)
-
-If you think that this file is causing problems to Ayadn or if it's simply getting too big, just trash it.
-
-The file is: `%USERNAME%/ayadn/data/username/db/users.db`  
-
-## TIPS    
-
-### Skip specific posts
-
-You can make posts containing a specific *hashtag*, like "#sports", or from a specific *client*, like "IFTTT" disappear from your timeline. 
-
-It works with users too: although App.net has the *mute* feature, it doesn't prevent the muted user to appear in reposts or to see posts mentioning him/her. This command allows you to do it.
-
-*ayadn skip-xxx add/remove target* to add/remove from the 'skipped' list.
-
-- Skip posts from specific client:
-
-`ayadn skip-source add IFTTT`
-
-- Skip posts with specific hashtag:
-
-`ayadn skip-tag add sports`
-
-- Skip posts with mentioning specific user:
-
-`ayadn skip-mention add username`
-
-Change of mind? 
-
-`ayadn skip-source remove IFTTT`
-`ayadn skip-tag remove sports`
-`ayadn skip-mention remove username`
-
-There's basically no verification with this feature, so be careful to not add misspelled or non-existent info.  
-
-### Backup some data
-
-```
-ayadn backup followings @ericd
-ayadn backup followers @ericd
-ayadn backup muted
-```  
-
-A JSON file containing the username and real name of your followings/followers/muted will be saved in `%USERDIR%/ayadn/data/lists`.
-
-The `muted` option only works for yourself (this is a normal limitation from the API).
-
-### Post links
-
-- Write/paste a simple link:
-
-```
-ayadn write 'Subscribe to the #Ayadn broadcast! https://app.net/c/2zqf'
-```  
-
-- Write/paste a markdown link to embed the link:
-
-```
-ayadn write '[Subscribe](https://app.net/c/2zqf) to the #Ayadn broadcast!'
-```  
-
-### Reset pagination data
-
-If Ayadn shows you "No recent posts" but you still want to see the stream again, you have to reset the pagination data first.
-
-```
-ayadn reset
-ayadn reset pagination unified
-ayadn reset pagination mentions @ericd
-ayadn reset pagination posts @ericd
-(etc)
-```  
-
-Without arguments: resets all your pagination data.  
-
-*Note: Ayadn doesn't use Stream Markers (stream syncing), and it's not a bug but a feature :p This is because Ayadn is meant as an independent tool that shouldn't interfere with other ADN clients.*  
-
-### Custom posts count
-
-You can specify the number of posts retrieved with most streams:
-
-```
-ayadn unified 10
-ayadn global 10
-ayadn checkins 10
-ayadn photos 10
-ayadn trending 10
-ayadn conversations 10
-ayadn mentions @ericd 10
-ayadn posts @ericd 10
-ayadn starred @ericd 10
-```  
-
-### Pinboard
-
-Export a post link + text + tags to Pinboard:
-
-`ayadn pin 15723266 tag1,tag2`  
-
-### "me"
-
-With some features you can replace `@username` by `me` if you want to check yourself:
-
-```
-ayadn mentions me
-ayadn scroll mentions me
-ayadn posts me
-ayadn starred me
-ayadn infos me
-ayadn list followings me
-(etc)
-```  
-
-### Shortcuts
-
-Some commands have shortcuts:  
-
-- write: w
-- reply: r
-- quote: q
-- mentions: m
-- posts: p
-- channels: ch
-- messages: msg
-- infos: i
-- convo: c
-- tag: t
-- search: s
-- nowplaying: np
-- help: h
-
-Examples:  
-
-```
-ayadn w
-ayadn r 12345678
-ayadn m @ericd
-ayadn t ruby
-ayadn np
-```  
+Install:
 
-*Other commands don't have a shortcut, reducing the risk of accidental manipulation.*
+`gem install ayadn`  
 
-### Channels
+Update:
 
-You may display your channels with `ayadn channels` and read their messages with `ayadn messages 12345` with 12345 being the channel ID.
+`gem update ayadn`
 
-To ease the process, you can create aliases for channel IDs:
+### OS X, LINUX, BSD
 
-`ayadn alias-channel 12345 mychannel`
+Please use something like RVM or RBENV to install Ruby if necessary.
 
-then read its messages with `ayadn messages mychannel`.
+You can also use the Ruby shipped with your system but you shouldn't, as it would require root privileges.
 
-List your existing aliases with `ayadn list alias`.
+### WINDOWS
 
-Aliases are cumulable. If something goes wrong, just trash the file: `%USERNAME%/ayadn/data/username/db/channels_alias.db`   
+You have to run one more command:
 
-### Just for fun
+`gem install win32console -v 1.3.2`
 
-`ayadn random`  
+# DOCUMENTATION
 
-## CONTACT
+Read the [manual](https://github.com/ericdke/na/blob/master/MANUAL.md).
 
-Contact me on ADN [(@ericd)](http://alpha.app.net/ericd) if you have questions, ideas, or... if you know Ruby and you want to help a newbie to code better. ;)
+# CONTACT
 
-The app's account is [@ayadn](http://alpha.app.net/ayadn) and will be used for support, bug report, etc.
+Author: [@ericd](http://app.net/ericd)
 
-There's also a [Broadcast channel](https://app.net/c/2zqf) for important announcements.
+App account: [@ayadn](http://app.net/ayadn)
 
-Don't bother with @ayaio or @aya_tests, they're bots. 
+Website: [ayadn-app.net](http://ayadn-app.net)