ayadn 1.8.2 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc40902646614f7f39c512c4d8d7628c708ef905
-  data.tar.gz: bb3f83c664b67aaca653b8db7b94c67ae3a91ff2
+  metadata.gz: c1b09b74834052e1267aa323844891a09876e715
+  data.tar.gz: 2bdb03f76102438274b874cabb81c5af148dcd8f
 SHA512:
-  metadata.gz: ebcc7f9b8c6a404f2b324ac9f0a68235bf85a071f137ee3d97d2af4791cea10a41916bdf3c7cf292a0187f52365fb44befc8ce710fbadeb74df6319759a14a09
-  data.tar.gz: 079b43ae0ee6e536e1acdf1aaefb639940c93bc59dce831efbc32600eb97a3e40823dd3f21415cf177dc76dbdfe76f9a0f92f97c79f59174d66fe10b4fec30cc
+  metadata.gz: f4849d039e5cdb5ee8c10e7ff5e5085324a0b4992c9bd40b7051c007fc477a21280ab866dea6d68d0d6f50bd9d92af25280e414b954ef65dfe00f1be80986266
+  data.tar.gz: faae501b8bfc0e2a676d986d344c471d3a1c983d65730baf4b5148f4491a906155abe43b994d18f6c3e858550e0c85ac3a9190b355c6f8dd398ce556db942fc6

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 .tags*
+tags
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -12,8 +13,11 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/mock/ayadn.log
 test/tmp
 test/version_tmp
 tmp
 token
 fake.db
+.ruby-version
+*.zip

data/CHANGELOG.md

@@ -1,12 +1,33 @@
-# 1.8.2 - 2014-10-31 - 'Asylum'
+## 2.0 - 2014-11-15 - 'The Piper At The Gates Of Dawn'
+
+- SQLite database. Means FAST!
+- Unified style for statuses, questions and alerts
+- NowPlaying: better results, custom hashtag, custom text
+- Channels: option to show only broadcasts/PMs/patter/other
+- Users lists: sort by username, name, total posts or posting frequency
+- Star/unstar/repost/unrepost/userinfos accept several targets
+- Ayadn instances share access to the blacklist
+- Unauthorize an Ayadn user account
+- Posts index resolution is active by default
+- Option: force view to be temporarily "compact"
+- Setting: show tables borders (default: true)
+- Setting: short date in timeline when scrolling (default: true)
+- Setting: blacklist active (default: true)
+- Spinner: better display when scrolling
+- Simplified, shorter settings names
+- NiceRank filter for Global is cached in-memory
+- Inline help and online docs have been updated
+- Code has been optimized. Bugs have been squashed.
+
+## 1.8.2 - 2014-10-31 - 'Asylum'
 
 - Fix: directed posts in timeline, bis
 
-# 1.8.1 - 2014-10-31 - 'Stockholm'
+## 1.8.1 - 2014-10-31 - 'Stockholm'
 
 - Fix: directed posts in timeline
 
-# 1.8.0 - 2014-10-29 - 'Cascadeur'
+## 1.8.0 - 2014-10-29 - 'Cascadeur'
 
 - New: command to view all unread PMs
 - New: channel commands can update unread status (default: true)
@@ -18,7 +39,7 @@
 - Update: debug info included in posts annotations
 - Update: gem dependencies
 
-# 1.7.7 - 2014-10-26 - 'The Twins'
+## 1.7.7 - 2014-10-26 - 'The Twins'
 
 - Fix: max characters information when sending to a channel
 - Fix: line break at the end of stream if compact view
@@ -30,43 +51,43 @@
 - New: option to show OEmbed links from channels/messages
 - New: extracted links are exported to a json file
 
-# 1.7.6 - 2014-10-25 - 'Barrie'
+## 1.7.6 - 2014-10-25 - 'Barrie'
 
 - Fix: channels parser (response != 200, working status)
 - Fix: settings list with compact view
 
-# 1.7.5 - 2014-10-20 - 'Cirrus'
+## 1.7.5 - 2014-10-20 - 'Cirrus'
 
 - New: option to display a compact view for the timeline
 - Fix: character count in reply with Markdown links
 
-# 1.7.4 - 2014-09-21 - 'Elton'
+## 1.7.4 - 2014-09-21 - 'Elton'
 
 - Fix: nowplaying (show artwork)
 - Fix: nowwatching (show posting account)
 - Fix: tvshow (show posting account)
 
-# 1.7.3 - 2014-09-08 - 'Scanners'
+## 1.7.3 - 2014-09-08 - 'Scanners'
 
 - New: option to reply to a reposted post
 - New: you can change the users lists order with `set`
 - New: you can change the table width with `set`
 - Docs: the documentation has been fixed and updated
 
-# 1.7.2 - 2014-09-04 - 'Fortress'
+## 1.7.2 - 2014-09-04 - 'Fortress'
 
 - Fixed: option to retrieve only specified channels in Channels
 - Fixed: validators for Set
 - New: better tests suite
 
-# 1.7.1 - 2014-09-02 - 'Poltergeist'
+## 1.7.1 - 2014-09-02 - 'Poltergeist'
 
 - New: update your user profile (full name, bio (user description), avatar, cover, Twitter username, blog url, web url)
 - Update profile: option to delete the field instead of updating
 - New: option to retrieve only specified channels in Channels
 - New: option to display raw response in Channels
 
-# 1.7.0 - 2014-08-21 - 'Private Investigations'
+## 1.7.0 - 2014-08-21 - 'Private Investigations'
 
 - New: embed a Youtube video in a normal post with option `-Y`
 - New: embed a Vimeo video in a normal post with option `-V`
@@ -78,7 +99,7 @@
 - Fixed: value displayed when setting NiceRank
 - Refactored a few classes and methods
 
-# 1.6.0 - 2014-08-04 - 'Beetlejuice'
+## 1.6.0 - 2014-08-04 - 'Beetlejuice'
 
 - New command: 'movie'. Create a post from a movie title (with link + movie poster). Customisable hashtag (default: '#nowwatching').
 - New command: 'tvshow'. Create a post from a TV show title (with link + show poster). Customisable hashtag (default: '#nowwatching'). Option to display a banner instead of a poster.
@@ -89,11 +110,11 @@
 - Fixed: bookmark convos.
 - General code cleaning and refactoring.
 
-# 1.5.1 - 2014-07-27 - 'Holograms'
+## 1.5.1 - 2014-07-27 - 'Holograms'
 
 - Improved accuracy of iTunes Store requests for NowPlaying
 
-# 1.5.0 - 2014-07-25 - 'Nozomi'
+## 1.5.0 - 2014-07-25 - 'Nozomi'
 
 - In 'convo', both the post id you've requested and the post it replies to are marked with arrows
 - Same feature in the view after a reply
@@ -106,19 +127,19 @@
 - Skipped objects are logged if debug is enabled
 - Force delete obsolete config keys / force create mandatory ones (less checks in the code, more stability)
 
-# 1.4.6 - 'Roman'
+## 1.4.6 - 'Roman'
 
 - Temporary fix for filepaths instability when uploading pictures
 
-# 1.4.5 - 2014-07-19 - 'Sébastien'
+## 1.4.5 - 2014-07-19 - 'Sébastien'
 
 - Fixed a crash when iTunes Store URL contained exotic characters
 
-# 1.4.4 - 'Randolph'
+## 1.4.4 - 'Randolph'
 
 - Fixed a database problem in PM and SEND
 
-# 1.4.3 - 2014-07-17 - 'Sergent Stretch'
+## 1.4.3 - 2014-07-17 - 'Sergent Stretch'
 
 - NowPlaying is compatible with iTunes and Last.fm. Default: iTunes. Add `--last-fm` or `-l` to get Last.fm last played track instead
 - NowPlaying audio link has been replaced with an iTunes Store link
@@ -128,29 +149,29 @@
 - Automatically fixes the arguments order for 'post' if needed when uploading a picture
 - General code cleaning
 
-# 1.4.2 - 2014-07-15 - 'Caligula'
+## 1.4.2 - 2014-07-15 - 'Caligula'
 
 - Ayadn is more resilient to connectivity errors
 - Better handling of filenames when uploading
 
-# 1.4.1 - 'Oh boy'
+## 1.4.1 - 'Oh boy'
 
 - A few fixes in the NowPlaying section
 
-# 1.4.0 - 2014-07-14 - 'Florian'
+## 1.4.0 - 2014-07-14 - 'Florian'
 
 - New feature: embed one or several pictures within a post (in write, post, reply, and pm)
 - Nowplaying inserts preview URL and album art from iTunes Store (you can prevent this with: `--no-url`)
 
-# 1.3.2 - 'Max'
+## 1.3.2 - 'Max'
 
 - Fixed: Global stream crashed if NiceRank was enabled but unreachable
 
-# 1.3.1 - 2014-06-16 - 'Nico'
+## 1.3.1 - 2014-06-16 - 'Nico'
 
 - NiceRank threshold is a float again. Default value is 2.1
 
-# 1.3.0 - 2014-06-09 - 'K'
+## 1.3.0 - 2014-06-09 - 'K'
 
 - Updated the NiceRank API url
 - NiceRank filter is more efficient (checks is_human + real_person)
@@ -163,18 +184,18 @@ Features:
 - Clear the contents of the blacklist database (ayadn -K clear)
 - Clear the contents of the bookmarks database (ayadn mark clear)
 
-# 1.2.10 - 'Anders'
+## 1.2.10 - 'Anders'
 
 - Fixed the non-installing unicode_utils Gem
 
-# 1.2.9 - 2014-05-29 - 'Kirschen'
+## 1.2.9 - 2014-05-29 - 'Kirschen'
 
 - NiceRank database auto-limits to 10000 users
 - Better handling of connection errors
 - Better display of emojis
 - General code cleaning
 
-# 1.2.8 - 2014-05-27 - 'Hans'
+## 1.2.8 - 2014-05-27 - 'Hans'
 
 - No more Ruby 1.9.3
 - Search for users: returns a detailed view of users containing word(s) in their bio/description
@@ -183,11 +204,11 @@ Features:
 - Search for words in messages (PMs)
 - Better display of the starred and replied_to symbols
 
-# 1.2.7 - 'Roman'
+## 1.2.7 - 'Roman'
 
 - Conform remove_arobase in Switch
 
-# 1.2.6 - 'Saket'
+## 1.2.6 - 'Saket'
 
 - NiceRank enabled by default on new installs
 - NiceRank cache expires after 48h by default
@@ -196,15 +217,15 @@ Features:
 - More debug info
 - Misc fixes related to recent features
 
-# 1.2.5 - 'Bis repetita'
+## 1.2.5 - 'Bis repetita'
 
 - Fix the NiceRank filter staying on true
 
-# 1.2.4 - 2014-05-25 - 'Stoopid me'
+## 1.2.4 - 2014-05-25 - 'Stoopid me'
 
 - Fix the copy/paste error in Settings
 
-# 1.2.3 - 'Taylor'
+## 1.2.3 - 'Taylor'
 
 - Text containing '#' but not an hashtag: not colorized
 - Add/remove several elements to/from blacklist at once
@@ -214,37 +235,37 @@ Features:
 - Option for showing debug messages
 - Show spinner = true
 
-# 1.2.2 - 2014-05-21 - 'Chris'
+## 1.2.2 - 2014-05-21 - 'Chris'
 
 - No more empty lines in the scroll
 - Spinner while waiting for posts (false by default)
 - Hashtags support accented characters
 
-# 1.2.1 - 2014-05-20 - 'Vinz'
+## 1.2.1 - 2014-05-20 - 'Vinz'
 
 - Fixed the exclusion bug in NiceRank filters
 - Improved the truncation in Mark list
 - Changes to match changes in NiceRank API
 
-# 1.2.0 - 2014-05-19 - 'Jason'
+## 1.2.0 - 2014-05-19 - 'Jason'
 
 - @matigo's NiceRank filter for the Global stream
 
-# 1.1.3 - 2014-05-17 - 'Kevin'
+## 1.1.3 - 2014-05-17 - 'Kevin'
 
 - Bookmark a conversation
 - List, delete, rename bookmarks
 
-# 1.1.2 - 'Craig'
+## 1.1.2 - 'Craig'
 
 - URL for the docs
 
-# 1.1.1 - 2014-05-07 - 'State Of The Onion'
+## 1.1.1 - 2014-05-07 - 'State Of The Onion'
 
 - Star and unstar a reposted post
 - Nowplaying shows an error message if iTunes is closed or not currently playing any track
 
-# 1.1.0 - 2014-04-28 - 'Leviathan'
+## 1.1.0 - 2014-04-28 - 'Leviathan'
 
 - Show who's writing, and who's the recipient
 - Less help text when writing, more concise
@@ -256,38 +277,38 @@ Features:
 - New command: photos stream
 - New command: delete message (private or in a channel)
 
-# 1.0.13 - 2014-04-25 - 'Charlotte'
+## 1.0.13 - 2014-04-25 - 'Charlotte'
 
 - New layout for '#nowplaying'
 - Compact index.db and pagination.db if necessary
 - New api urls
 - Fix 'download file'
 
-# 1.0.12 - 'Rolando'
+## 1.0.12 - 'Rolando'
 
 - Fixed an error in: authorizing an account if its folders already exists
 
-# 1.0.11 - 'Chris'
+## 1.0.11 - 'Chris'
 
 - There was a typo in the last version that caused a bug in the PM command
 
-# 1.0.10 - 'Johannes'
+## 1.0.10 - 'Johannes'
 
 - Fixes the help bug (doubled commands)
 - Auto adds the @ if missing in pm
 
-# 1.0.9 - 'Brian'
+## 1.0.9 - 'Brian'
 
 - Fixes the stubborn 'nowplaying' database bug
 
-# 1.0.8 - 2014-04-16 - 'Laurent'
+## 1.0.8 - 2014-04-16 - 'Laurent'
 
 - Better error messages/logs (specifically when HTTP errors)
 - Token is anonymized if in error logs
 - No more database error when canceling a 'nowplaying' post
 - Better mentions colorization
 
-# 1.0.7 - 2014-04-13 - 'Hugo'
+## 1.0.7 - 2014-04-13 - 'Hugo'
 
 - Machine-only messages in channels are now viewable
 - Don't output "Downloading" if options = raw in messages view
@@ -295,28 +316,28 @@ Features:
 - Removed username in front of ">>" in Auto (in case the authd user changed)
 - Compatibility with Windows is broken
 
-# 1.0.6 - 2014-04-12 - 'Matthew'
+## 1.0.6 - 2014-04-12 - 'Matthew'
 
 - Fixed a bug where post_max_chars was displayed instead of message_max_chars
 - Show raw JSON in messages even if no data
 
-# 1.0.5 - 'Joel'
+## 1.0.5 - 'Joel'
 
 - Fixed the colorization for mentions
 - Added tests for colorization
 
-# 1.0.4 - 2014-04-06 - 'Jeremy'
+## 1.0.4 - 2014-04-06 - 'Jeremy'
 
 - Fixed 'reply to an indexed stream' for Ruby < 2.1
 - More tests for Databases
 - Tests for Blacklist
 - Tests for Set
 
-# 1.0.3 - 'Donny'
+## 1.0.3 - 'Donny'
 
 - Fixed the bug introduced by the last bugfix (yes, I know... sigh...)
 
-# 1.0.2 - 'Mark'
+## 1.0.2 - 'Mark'
 
 - Fixed a critical bug in Reply (when the original post was a repost)
 - Tests for Databases
@@ -324,7 +345,7 @@ Features:
 - Better layout for checkins
 - Better alert message if error 429
 
-# 1.0.1 - 2014-04-04 - 'Phoenix'
+## 1.0.1 - 2014-04-04 - 'Phoenix'
 
 Release!
 

data/README.md

@@ -7,7 +7,7 @@ AYADN
 
 [App.net](http://app.net) command-line client.
 
-The purpose of Ayadn is to let you use all the features of App.net from the console without any headaches... and then more: power, freedom and fun!
+With Ayadn, you can use all the features of App.net from the console without any headaches... and then more: power, freedom and fun!
 
 - view/scroll all streams 
 - view/scroll conversations
@@ -20,7 +20,7 @@ The purpose of Ayadn is to let you use all the features of App.net from the cons
 - view/scroll posts from specific users or posts mentioning a user
 - follow/unfollow users, star/repost/mute/block/unstar/etc 
 - create local bookmarks for conversations
-- get information about users and their followers/followings
+- get detailed information about users and their followers/followings
 - search for words, hashtags, post annotations, channels, etc
 - extract links from conversations, streams, posts, etc
 - list and download your files
@@ -30,7 +30,7 @@ The purpose of Ayadn is to let you use all the features of App.net from the cons
 - 'tvshow' creates a post from a TV show title with poster, plot, and link
 - view/send private messages
 - view geolocation data in streams
-- create silent black lists of users, mentions or hashtags
+- create silent black lists of users, mentions, clients or hashtags
 - create aliases for easier use of channels ids
 - update your user profile
 - export links and text from a post to Pinboard
@@ -79,3 +79,17 @@ ADN Directory: [Ayadn](https://directory.app.net/app/345/ayadn/)
 # FEEDBACK
 
 Feedback and/or contributions are very welcomed!
+
+# SCREENSHOTS
+
+Examples on Mac OS X, with iTerm2 + Solarized theme.
+
+![followers list](https://www.dropbox.com/s/es0o4sq7w05y2ps/ayadn200followerslistsmall.png?dl=1)
+
+![mentions stream in classic view](http://dl.dropboxusercontent.com/s/16d7u5wjsd3un1j/ayadn200mentions.png)
+
+![conversation in compact view](http://dl.dropboxusercontent.com/s/3nl5fhguhzr61x9/ayadn200convocompact.png)
+
+![posting to App.net](http://dl.dropboxusercontent.com/s/74ehkepj9u1ffbz/ayadn200posting.png)
+
+![list of commands](https://dl.dropboxusercontent.com/s/4cuprxyc2xtjm1w/ayadncommands.png)

data/ayadn.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{App.net command-line client: toolbox to access and manage your ADN data, show your streams, post, manage conversations, star/follow/repost... and many, many more.}
   spec.homepage      = "http://ayadn-app.net"
   spec.license       = "MIT"
-  spec.metadata      = { "documentation" => "http://ayadn-app.net/doc/" }
+  spec.metadata      = { "documentation" => "https://github.com/ericdke/na/tree/master/doc" }
 
   spec.bindir        = 'bin'
   spec.files         = `git ls-files`.split("\n")
@@ -31,14 +31,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "unicode_utils", "~> 1.4"
   spec.add_dependency "spotlite", "~> 0.8"
   spec.add_dependency "tvdb_party", "~> 0.7"
+  spec.add_dependency "amalgalite", "~> 1.3"
+  spec.add_dependency "fast_cache", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rb-fsevent", "~> 0.9"
-  spec.add_development_dependency "guard-rspec", "~> 4.3"
   spec.add_development_dependency "coveralls", "~> 0.7"
-  #spec.add_development_dependency "fakefs", "~> 0.5"
 
   spec.post_install_message = "Thank you for installing Ayadn!"
 end

data/doc/01-index.md

@@ -1,8 +1,9 @@
-# AYADN
+AYADN
+=====
 
 [App.net](http://app.net) command-line client.
 
-The purpose of Ayadn is to let you use all the features of App.net from the console without any headaches... and then more: power, freedom and fun!
+With Ayadn, you can use all the features of App.net from the console without any headaches... and then more: power, freedom and fun!
 
 - view/scroll all streams 
 - view/scroll conversations
@@ -15,7 +16,7 @@ The purpose of Ayadn is to let you use all the features of App.net from the cons
 - view/scroll posts from specific users or posts mentioning a user
 - follow/unfollow users, star/repost/mute/block/unstar/etc 
 - create local bookmarks for conversations
-- get information about users and their followers/followings
+- get detailed information about users and their followers/followings
 - search for words, hashtags, post annotations, channels, etc
 - extract links from conversations, streams, posts, etc
 - list and download your files
@@ -25,7 +26,7 @@ The purpose of Ayadn is to let you use all the features of App.net from the cons
 - 'tvshow' creates a post from a TV show title with poster, plot, and link
 - view/send private messages
 - view geolocation data in streams
-- create silent black lists of users, mentions or hashtags
+- create silent black lists of users, mentions, clients or hashtags
 - create aliases for easier use of channels ids
 - update your user profile
 - export links and text from a post to Pinboard
@@ -40,4 +41,4 @@ There's also two exclusive antispam and filtering features: a blacklist of users
 
 Last but not least: Ayadn supports multiple ADN accounts! 
 
-Authorize as many accounts as you wish, and simply switch between them in a second. 
+Authorize as many accounts as you wish, and simply switch between them in a second. 

data/doc/02-install.md

@@ -20,4 +20,26 @@ You can of course use the Ruby shipped with your system but it will require root
 
 ## WINDOWS
 
-Ayadn 1.x isn't compatible with Windows: there's too many issues due to external Gems and POSIX-dependant tools.  
+Ayadn 1.x isn't compatible with Windows: there's too many issues due to POSIX-dependent tools.  
+
+## MIGRATE
+
+The database format has changed between 1.x and 2.x: if you already have one or several authorized accounts, Ayadn will ask you to run the `migrate` command once per account. You only have to do this once.
+
+You can also, if you wish, start anew and delete your `~/ayadn` folder before authorizing a new user with Ayadn 2.x.
+
+## DEPENDENCIES
+
+Ayadn depends on these Gems:
+
+        amalgalite
+        daybreak
+        fast_cache
+        pinboard
+        rainbow
+        rest-client
+        spotlite
+        terminal-table
+        thor
+        tvdb_party
+        unicode_utils

data/doc/03-first-steps.md

@@ -6,10 +6,6 @@ You have to give Ayadn the authorization to use your App.net account.
 
 Just run 
 
-`ayadn authorize` 
-
-or 
-
 `ayadn -auth` 
 
 to register a new user.  
@@ -32,51 +28,45 @@ or
 
 `ayadn -@ ericd`  
 
+You can also unauthorize a user with or without deleting its folders:
+
+`ayadn unauthorize @ericd`
+
+or
+
+`ayadn -UA -D @ericd`
+
 ## DATA
 
 All Ayadn files and folders are created in your 'home' folder. 
 
-On Mac OS X, it looks like this:
-
 ```
-  /Users/ericdke/ayadn/
-  ├── accounts.db
-  /Users/ericdke/ayadn/ericd
+  /Users/user/ayadn/
+  ├── accounts.sqlite
+  /Users/user/ayadn/ericd
   ├── auth
   │   └── token
-  ├── backup
   ├── config
   │   ├── api.json
   │   ├── config.yml
   │   └── version.yml
   ├── db
-  │   ├── aliases.db
-  │   ├── blacklist.db
-  │   └── users.db
+  │   └── ayadn.sqlite
   ├── downloads
   ├── lists
   ├── log
   │   └── ayadn.log
   ├── messages
-  ├── pagination
-  │   ├── index.db
-  │   └── pagination.db
   └── posts
 ```
 
-Each authorized account has its set of folders and databases.
-
-This is also the repository of the configuration file: 
-
-`config.yml`
-
-Although there's the `set` command in Ayadn to configure most parameters, you can of course edit the file manually.
+Each authorized account has its set of folders, a config file and a database.
 
 If you're not sure if your config file is up to date or properly filled and you want to benefit from the new options in Ayadn, run 
 
 `ayadn set defaults` 
 
-and it will create a brand new file with optimal values.  
+and it will create a brand new file with default values.  
 
 ## HELP
 
@@ -98,23 +88,27 @@ Examples:
 
 And for the subcommands:
 
-`ayadn blacklist help import`
+`ayadn blacklist help delete`
 
 `ayadn alias help create`  
 
+It also works with the shortcuts:
+
+`ayadn help -tl`  
+
+`ayadn help -K` 
 
 ## SHORTCUTS
 
-Most examples in the documentation include the 'complete' command followed by the 'shortcut' command. 
+Examples in the documentation include the complete command followed by its shortcut version. 
 
 Of course, using Ayadn is much faster with the shortcut commands.
 
 If you're like me, you'll even want to create aliases in bash/zsh or TextExpander snippets for the combinations of Ayadn commands and options you use the most...  
 
-
 ## EXAMPLES
 
-Just a few examples to give you a hint at the flexible syntax.
+Just a few examples of commands to give you a hint at the flexible syntax.
 
 Complete:    
 

data/doc/04-options.md

@@ -4,7 +4,7 @@ Note: options are only described once in this manual (in the first example for '
 
 **However, options are available for mosts of streams!** 
 
-They're described only once *for readability purposes*.
+They're described only once to ensure this documentation keeps being readable.
 
 You can always check if a command has specific options with