do_stuff 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/LICENSE +13 -0
  2. data/README.md +67 -0
  3. metadata +3 -1
data/LICENSE ADDED
@@ -0,0 +1,13 @@
1
+ Copyright (c) 2012, Scott Olson
2
+
3
+ Permission to use, copy, modify, and/or distribute this software for any
4
+ purpose with or without fee is hereby granted, provided that the above
5
+ copyright notice and this permission notice appear in all copies.
6
+
7
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
8
+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9
+ AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
10
+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
11
+ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
12
+ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
13
+ PERFORMANCE OF THIS SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,67 @@
1
+ do\_stuff
2
+ ========
3
+
4
+ Do\_stuff is a minimalistic command line todo list manager that doesn't get in
5
+ your way. I created it because I could not find a todo list manager that I
6
+ didn't dislike for some reason or another. Do\_stuff is simple in features and
7
+ simple in code (written in one night).
8
+
9
+ Install
10
+ -------
11
+
12
+ ``` bash
13
+ gem install do_stuff
14
+ echo /path/to/todo.txt > ~/.do_stuffrc
15
+ ```
16
+
17
+ It turns out using do\_stuff through RubyGems leads to noticably longer
18
+ start-up times, so I recommend the following, assuming `~/bin` is in your
19
+ `PATH`:
20
+
21
+ ``` bash
22
+ do_stuff --standalone ~/bin/t
23
+ ```
24
+
25
+ Now you can use `t` just like you would `do_stuff`, and it's fast!
26
+
27
+ Usage
28
+ -----
29
+
30
+ See `t -h`. Examples of use below.
31
+
32
+ ```
33
+ [~]$ t That thing I need to do.
34
+ Added #1: That thing I need to do.
35
+ [~]$ t
36
+ 1. That thing I need to do.
37
+ [~]$ t -e # edit the todo.txt in $EDITOR
38
+ [~]$ t Another thing.
39
+ Added #3: Another thing.
40
+ [~]$ t And another.
41
+ Added #4: And another.
42
+ [~]$ t ALL the things.
43
+ Added #5: ALL the things.
44
+ [~]$ t
45
+ 1. That thing I need to do.
46
+ 2. That thing I added from -e.
47
+ 3. Another thing.
48
+ 4. And another.
49
+ 5. ALL the things.
50
+ [~]$ t 2
51
+ Erased #2: That thing I added from -e.
52
+ [~]$ t 4
53
+ Erased #4: And another.
54
+ [~]$ t
55
+ 1. That thing I need to do.
56
+ 3. Another thing.
57
+ 5. ALL the things.
58
+ [~]$ t Edit my todo list.
59
+ Added #2: Edit my todo list.
60
+ [~]$ t
61
+ 1. That thing I need to do.
62
+ 2. Edit my todo list.
63
+ 3. Another thing.
64
+ 5. ALL the things.
65
+ [~]$ t -e2 # start $EDITOR at task 2 in todo.txt (if possible)
66
+ ```
67
+
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: do_stuff
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -23,6 +23,8 @@ files:
23
23
  - lib/do_stuff/todolist.rb
24
24
  - lib/do_stuff.rb
25
25
  - bin/do_stuff
26
+ - README.md
27
+ - LICENSE
26
28
  homepage: https://github.com/tsion/do_stuff
27
29
  licenses: []
28
30
  post_install_message: