timkaechele/working_class
1
0
Fork 0
Code

added a roadmap

Browse Source
This commit is contained in:
Tim Kächele 2016-05-29 14:45:01 +02:00
parent 93ef6f8970
commit ade566ff96
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,6 +1,6 @@
# WorkingClass [![Build Status](https://travis-ci.org/TimKaechele/WorkingClass.svg?branch=master)](https://travis-ci.org/TimKaechele/WorkingClass) # WorkingClass [![Build Status](https://travis-ci.org/TimKaechele/WorkingClass.svg?branch=master)](https://travis-ci.org/TimKaechele/WorkingClass)
WorkingClass is an human readable syntax to write tasklists. WorkingClass is a human readable syntax to write tasklists.
Besides being easy to read it's fully parseable, so you can work with the tasks Besides being easy to read it's fully parseable, so you can work with the tasks
in Ruby. in Ruby.
@ -18,17 +18,28 @@ And then execute:
$ bundle $ bundle
``` ```
Or install it yourself as: Or install it yourself with:
```sh ```sh
$ gem install working_class $ gem install working_class
``` ```
## Roadmap
Currently the parser is quite bloated and needs some refinement, this will happen in the next weeks.
By doing so I will add some more features to the gem like:
- support for nested tasks (a task should have the ability to have subtasks)
- support for task priorities
- support to serialize a tasklist into the WorkingClass syntax (add write support)
- support for a more pleasant date syntax
## Usage ## Usage
### The Syntax ### The Syntax
Keep in mind that all dates are formatted like this: `DD.MM.YYYY` or `D.M.YY` Keep in mind that all dates are formatted like this: `D(D).M(M).YY(YY)`.
``` ```
Tasklist Name Tasklist Name