recollect 0.0.1 → 0.0.2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f81e3005b101852633f48d786a7e5ec784a22f24
4
- data.tar.gz: b6e1d9c8c52b8409bdb55c652ee07e20e8d500aa
3
+ metadata.gz: 34f432868c90cabcb0e7c9d39f39db8e89931d30
4
+ data.tar.gz: 65a98ba2cf94ab8d1dab1093b536b2af9595b256
5
5
  SHA512:
6
- metadata.gz: 78ff54fa471dce776dc219db37608773b7685ee69078c425dc49f375fe1c00146c41fd6942688250312add7587cff29623a2d785c681485ddf4228face6f2441
7
- data.tar.gz: 3974c2e56cce5b7ee556540b866bfe0af02fedbaecdc231a2aaf4f13adb2270df516a158b6b1dc934b62f809687542b782103b017b56635019b96d32106502f2
6
+ metadata.gz: d7a72bfeceeacac8c4cc92d74c6db51bbd671a48aa6c2c7e745dd8693e7f67286a508ea85a454117a64d7b8d3c3f49ef69997cc5e38700dc161c9511d755671b
7
+ data.tar.gz: baf5d9f665a5fd36525e0502b8c6110775f9bf240f89fb8455f80a5b5e30a2c9b86220ffed8ef88fb4f11a15428a763faf62e77f91342c989db6862f1f6660c3
data/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Recollect
2
- A simple tool for creating, managing, and viewing snippets, notes, or pretty much any other text-based content at the command line. The original purpose was to store infrequently used complex command strings in a location where they could easily be indexed and retrieved.
2
+ A simple tool for creating, managing, and viewing snippets, notes, or pretty much any other text-based content at the command line. The original purpose was to store infrequently used complex command strings in a location where they could easily be indexed and retrieved. Text files are stored under `~/.recollections` and can be accessed using other tools or methods (e.g. Git, Dropbox, etc).
3
3
 
4
4
  *Note* If you find yourself outlining complex procedures, you should consider if a shared team knowledge base might be a better fit.
5
5
 
@@ -11,9 +11,13 @@ If you haven't already, you should set your EDITOR. On OSX you can set it to Tex
11
11
 
12
12
  echo 'export EDITOR="mate -w" >> ~/.bash_profile
13
13
 
14
- ### Walkthrough
15
-
16
-
17
-
18
-
14
+ ### Usage
19
15
 
16
+ USAGE: recollect ACTION [arg]
17
+ Actions: list, new, edit, or <name> where <name> is the recollection to be displayed.
18
+ list - provides a listing of all available recollections
19
+ name - displays the recollection matching 'name'
20
+ new [name] - provides a listing of all available recollections
21
+ edit [name] - provides a listing of all available recollections
22
+ remove [name] - removes a recollections
23
+ Note: ["new", "edit", "remove", "help"] are reserved and cannot be the name of a recollection.
data/TODO CHANGED
@@ -1,16 +1,9 @@
1
1
  Known Issues:
2
2
 
3
3
  - Add an open license
4
- - Convert to Ruby functionality only (no shell commands)
5
- - Need to reserve words so topics can't be (new, edit, remove, list, search)
6
4
 
7
5
  Feature Requests:
8
6
 
9
- - Make snippets directory ${HOME}/.recollect/
10
- - Build in paging functionality
11
- - Needs to obey ${EDITOR} environment variable (how does this play on Windows?)
12
7
  - Allow for the creation of nested snippets (sub-directories)
13
8
  - when listing, count topics in subdirectories but don't list the individual snippets
14
9
  - Add a search functionality that lists the snippet(s) containing the item searched for along with any matching content lines
15
- - Create a mobile app synced via dropbox?
16
- - add support for markdown instead of just txt files
@@ -3,7 +3,7 @@ require 'fileutils'
3
3
  module Recollect
4
4
  class Recollection
5
5
  def initialize(args)
6
- @reserved = %w[new edit remove help]
6
+ @reserved = %w[new edit remove help search]
7
7
  usage unless args.length >= 1 && args.length <= 2
8
8
  @action, @name = args
9
9
  usage if @reserved.include?(@action) && args.length < 2
@@ -1,3 +1,3 @@
1
1
  module Recollect
2
- VERSION = '0.0.1'
2
+ VERSION = '0.0.2'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: recollect
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tyler Poland