aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2018-12-26 18:52:21 +0100
committerJakob Odersky <jakob@odersky.com>2018-12-26 18:53:37 +0100
commit26d508647f3f37e371c12ce6e6e34c60bce19635 (patch)
tree57af847b8d4f29e39cb052c511ebd89fb6f9178d
parentb13be6260cad20a71006a827fb43cd7bb0621408 (diff)
downloadcodename-26d508647f3f37e371c12ce6e6e34c60bce19635.tar.gz
codename-26d508647f3f37e371c12ce6e6e34c60bce19635.tar.bz2
codename-26d508647f3f37e371c12ce6e6e34c60bce19635.zip
Add some example output
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5e8506d..0db4585 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,39 @@ This is a scala-native project. The binary can be built by running
`sbt nativeLink`. Version information is derived from git, with
initial "v" dropped (e.g. the tag v1.2.3 represents version 1.2.3).
+## Examples
+
+- `codename "A a n"`:
+
+ >very windy yaw
+
+ >awful patchy zero
+
+ >henceforth catchy graphite
+
+ >nonethless furious aleph
+
+ >otherwise jumpy route
+
+- `codename "a-n"`
+
+ >mellow-gazelle
+
+ >united-five
+
+ >optuse-joke
+
+- `codename "A a n a a n n"`
+
+ >approximately inherent omicron fabulous zillion unit set
+
+## Contributing
+
+Contributions are welcome, especially new words! It's hard to describe
+what words should be included, but the rule of thumb is to use words
+that generally have a low frequency in English text (although not
+necessarily archaic), and that sound interesting when said out loud.
+
## Usage
Refer to the help message of the utility (`codename --help`) for an
authoritative answer.