Update readme and documentation

Author: ia0

.travis.yml

@@ -1,3 +1,6 @@
+# Workaround for kcov. See https://github.com/travis-ci/travis-ci/issues/9061.
+sudo: required
+
 language: rust
 
 rust:
@@ -11,9 +14,9 @@ addons:
   apt:
     packages:
     - bc
-    - time
-    - libelf-dev
-    - libdw-dev
     - binutils-dev
+    - libdw-dev
+    - libelf-dev
+    - time
 
 script: ./travis.sh

README.md

@@ -79,8 +79,7 @@ lazy_static! {
 }
 ```
 
-If you use a nightly compiler, you may use the [macro] library to define a
-compile-time custom encoding:
+You may also use the [macro] library to define a compile-time custom encoding:
 
 ```rust
 const HEX: Encoding = new_encoding!{

lib/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Patch
 
+- Update readme and documentation
 - Add maintenance-related badges to Cargo.toml
 
 ## 2.1.0

lib/README.md

@@ -67,8 +67,7 @@ lazy_static! {
 }
 ```
 
-If you use a nightly compiler, you may use the [macro] library to define a
-compile-time custom encoding:
+You may also use the [macro] library to define a compile-time custom encoding:
 
 ```rust
 const HEX: Encoding = new_encoding!{

lib/src/lib.rs

@@ -68,6 +68,20 @@
 //! }
 //! ```
 //!
+//! You may also use the [macro] library to define a compile-time custom encoding:
+//!
+//! ```rust,ignore
+//! const HEX: Encoding = new_encoding!{
+//!     symbols: "0123456789abcdef",
+//!     translate_from: "ABCDEF",
+//!     translate_to: "abcdef",
+//! };
+//! const BASE64: Encoding = new_encoding!{
+//!     symbols: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",
+//!     padding: '=',
+//! };
+//! ```
+//!
 //! # Properties
 //!
 //! The [base16], [base32], [base32hex], [base64], and [base64url] predefined
@@ -152,6 +166,7 @@
 //! [constants]: index.html#constants
 //! [crate]: https://crates.io/crates/data-encoding
 //! [github]: https://github.com/ia0/data-encoding
+//! [macro]: https://crates.io/crates/data-encoding-macro
 
 #![warn(unused_results, missing_docs)]
 

travis.sh

@@ -63,8 +63,8 @@ info "Test library coverage"
 find target/debug -maxdepth 1 -type f -perm /u+x -printf '%P\n' |
   while IFS= read -r test; do
     info "Run $test"
-    ./kcov-master/build/src/kcov --verify --include-path=lib/src/ \
-                                 target/kcov-"$test" ./target/debug/"$test"
+    ./kcov-master/build/src/kcov --include-path=lib/src/ target/kcov-"$test" \
+                                 ./target/debug/"$test"
   done; unset test
 
 info "Send coverage to coveralls.io"