recollect 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f81e3005b101852633f48d786a7e5ec784a22f24
-  data.tar.gz: b6e1d9c8c52b8409bdb55c652ee07e20e8d500aa
+  metadata.gz: 34f432868c90cabcb0e7c9d39f39db8e89931d30
+  data.tar.gz: 65a98ba2cf94ab8d1dab1093b536b2af9595b256
 SHA512:
-  metadata.gz: 78ff54fa471dce776dc219db37608773b7685ee69078c425dc49f375fe1c00146c41fd6942688250312add7587cff29623a2d785c681485ddf4228face6f2441
-  data.tar.gz: 3974c2e56cce5b7ee556540b866bfe0af02fedbaecdc231a2aaf4f13adb2270df516a158b6b1dc934b62f809687542b782103b017b56635019b96d32106502f2
+  metadata.gz: d7a72bfeceeacac8c4cc92d74c6db51bbd671a48aa6c2c7e745dd8693e7f67286a508ea85a454117a64d7b8d3c3f49ef69997cc5e38700dc161c9511d755671b
+  data.tar.gz: baf5d9f665a5fd36525e0502b8c6110775f9bf240f89fb8455f80a5b5e30a2c9b86220ffed8ef88fb4f11a15428a763faf62e77f91342c989db6862f1f6660c3

data/README.md

@@ -1,5 +1,5 @@
 # Recollect
-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.
+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).
 
 *Note* If you find yourself outlining complex procedures, you should consider if a shared team knowledge base might be a better fit.
 
@@ -11,9 +11,13 @@ If you haven't already, you should set your EDITOR. On OSX you can set it to Tex
 
     echo 'export EDITOR="mate -w" >> ~/.bash_profile
 
-### Walkthrough
-
-
-
-
+### Usage
 
+    USAGE: recollect ACTION [arg]
+      Actions: list, new, edit, or <name> where <name> is the recollection to be displayed.
+        list        - provides a listing of all available recollections
+        name        - displays the recollection matching 'name'
+        new [name]  - provides a listing of all available recollections
+        edit [name] - provides a listing of all available recollections
+        remove [name]   - removes a recollections
+    Note: ["new", "edit", "remove", "help"] are reserved and cannot be the name of a recollection.

data/TODO

@@ -1,16 +1,9 @@
 Known Issues:
 
 - Add an open license
-- Convert to Ruby functionality only (no shell commands)
-- Need to reserve words so topics can't be (new, edit, remove, list, search)
 
 Feature Requests:
 
-- Make snippets directory ${HOME}/.recollect/
-- Build in paging functionality
-- Needs to obey ${EDITOR} environment variable (how does this play on Windows?)
 - Allow for the creation of nested snippets (sub-directories)
   - when listing, count topics in subdirectories but don't list the individual snippets
 - Add a search functionality that lists the snippet(s) containing the item searched for along with any matching content lines
-- Create a mobile app synced via dropbox?
-- add support for markdown instead of just txt files

data/lib/recollect/recollect.rb

@@ -3,7 +3,7 @@ require 'fileutils'
 module Recollect
   class Recollection
     def initialize(args)
-      @reserved = %w[new edit remove help]
+      @reserved = %w[new edit remove help search]
       usage unless args.length >= 1 && args.length <= 2
       @action, @name = args
       usage if @reserved.include?(@action) && args.length < 2

data/lib/recollect/version.rb

@@ -1,3 +1,3 @@
 module Recollect
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recollect
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tyler Poland