diff --git a/README.rst b/README.rst index 4aee506..503282f 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ | .. figure:: https://ptrace.hiveeyes.org/2019-06-29_vasuki-small.jpg - :target: https://en.wikipedia.org/wiki/Vasuki#/media/File:Kurma,_the_tortoise_incarnation_of_Vishnu.jpg + :target: https://en.wikipedia.org/wiki/File:Kurma,_the_tortoise_incarnation_of_Vishnu.jpg .. vasuki-readme: @@ -43,10 +43,32 @@ About ***** Vasuki generates different kinds of random unique identifiers, tokens, and words. + It can be used as a library and as an HTTP service, aiming to provide effortless identifier generation for your applications. +******** +Synopsis +******** +:: + + # UUIDv4 universally unique identifier. + vasuki uuid + + # ULID universally unique lexicographically sortable identifier. + vasuki ulid + + # Gibberish random, pronounceable pseudo-words + vasuki gibberish + + # MomentName short epoch slugs + vasuki moment + + # Nagamani19 short, unique, non-sequential identifier. + vasuki naga19 + + ******* Install ******* @@ -61,6 +83,10 @@ With service API:: pip install 'vasuki[service]' +Please note this software is a work in progress, and its interfaces may change. +For those reasons, if you use it as a dependency in your own programs, version +pinning is always recommended. + ******** Features @@ -84,7 +110,7 @@ Slugifiers Optional service API ==================== -The fine responder_ optionally exposes the machinery as HTTP API. +The fine responder_ library optionally exposes the machinery as HTTP API. .. _UUIDv4: https://en.wikipedia.org/wiki/Universally_unique_identifier .. _ULID: https://github.com/ulid/spec @@ -94,27 +120,6 @@ The fine responder_ optionally exposes the machinery as HTTP API. .. _responder: https://pypi.org/project/responder/ -******** -Synopsis -******** -:: - - # UUIDv4 universally unique identifier. - vasuki uuid - - # ULID universally unique lexicographically sortable identifier. - vasuki ulid - - # Gibberish random, pronounceable pseudo-words - vasuki gibberish - - # MomentName short epoch slugs - vasuki moment - - # Nagamani19 short, unique, non-sequential identifier. - vasuki naga19 - - ******** Examples ******** diff --git a/doc/backlog.rst b/doc/backlog.rst index 07ac691..7fbebff 100644 --- a/doc/backlog.rst +++ b/doc/backlog.rst @@ -8,7 +8,11 @@ Tasks Prio 1 ------ -- [o] Add compatibility with recent versions of ``typesystem`` (vs. ``responder``/``apistar``` +- [o] Add version number to ``index.html`` +- [o] Add software tests for ``vasuki service`` +- [o] Provide OCI image +- [o] Add license/warranty information to README and ``index.html`` +- [o] Add compatibility with recent versions of ``typesystem`` (vs. ``responder``/``apistar``) - https://github.com/taoufik07/responder/pull/430 - https://github.com/taoufik07/responder/issues/440 - https://github.com/encode/apistar/pull/675