From f7c693958615d40246e02390db306abd9e6f415a Mon Sep 17 00:00:00 2001 From: Prashant Sinha Date: Sat, 17 Sep 2016 15:37:55 +0530 Subject: [PATCH] Added proposed specs --- API Specs.md | 25 +++++++++++++++++++++++++ README.md | 1 - 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 API Specs.md diff --git a/API Specs.md b/API Specs.md new file mode 100644 index 0000000..2ddfdfa --- /dev/null +++ b/API Specs.md @@ -0,0 +1,25 @@ +# Hues Console + +> Notes. + +## API Considerations, Specs +Console API is borrowed from awesome Node.JS console api. [1] + +```python +>>> from hues import console + +>>> console.log +>>> console.error +>>> console.info +>>> console.warn +>>> console.assert +``` + +## Default color, theme settings +The default config is a JSON? YAML? file called .hues.[json/yml] in ~ or `cwd`. + +## tqdm integration +We can ship with a tqdm wrapper. + + +[1]: https://nodejs.org/api/console.html diff --git a/README.md b/README.md index 5ded23b..b196c36 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,3 @@ All 16 glorious ANSI colors are available for both background and foreground. As - [ ] Unicorns required. > Back in my days, we didn't even have colors! -