From 26d508647f3f37e371c12ce6e6e34c60bce19635 Mon Sep 17 00:00:00 2001 From: Jakob Odersky Date: Wed, 26 Dec 2018 18:52:21 +0100 Subject: Add some example output --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) 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. -- cgit v1.2.3