notes_cli 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73fe7f6770836515148031d07002166d3db2635f94508eb90f33757cceb8ecd6
-  data.tar.gz: 7eb9ee91974caa8b8f103da40c38b289f02b10d37a1a1244013790e0ce67294c
+  metadata.gz: 333db1b8b6dbbcd790a58549547ba44ddc8928fb63a4f1d1af1f565987da1865
+  data.tar.gz: be86e4e00485b7a7ebe8001565b40bde1002c057ce0ab7239e9d4d8a66ed95d1
 SHA512:
-  metadata.gz: 55c0ead38e7df4e746efe2cab82041ae226d4f444bd8ace2ec89d10ca861a1077a9057e245ffdb0146ec78277c7fef4b220de73c3a59a9f29f6a0b98b3ffe803
-  data.tar.gz: 531023291b416aa26e2c50e00c4fe37beba81cc99738ab33b5bf5b997ced661ab079777d0855b5952935e0474667472705b343dc46eb88d49c1d98a98ad0dac9
+  metadata.gz: 62e99f63a3bd462f3852227d54eabaee0e3982909d2317650bc84522f31921b47d34e26b5403953f961e89b18ce221a2f88c8d849d55664558b4fa1e686bb8ed
+  data.tar.gz: 89e4aa5bd7648cace82ed0febae82344cfcc4ed9ad8fc9c101d9ec0b88ad13b5419a42ed6d0b4ffa6c3226f451e2b64c43c985a59d1e6a1d6bd70a73e63b7b65

data/README.md

@@ -1,24 +1,34 @@
+# About
+Easily create, delete and list all your notes.  
+NotesCli lets you create workspaces and notebooks in which you can store notes.  
+Notes are created as md files for ease of storing code snippets.
+
+# Installation
+```bash 
+gem install notes_cli
+```
+
 # Getting started
 
-Tell notes_cli where your notes will be stored.
+Tell notes_cli where your notes will be stored
 ```bash
 notes --notes_folder path/to/where/you/will/store/notes
 ```
 
-Define your first workspace.
+Define your first workspace
 ```bash
 notes -w workspace_name
 ```
 
 # DSL
 ## Notes folder
-Where you will store all notes, including your workspaces and notebooks as the top layers.
+Where you will store all notes, including your workspaces and notebooks as the top layers
 
 ## Workspace
-Where you will store notebooks.
+Where you will store notebooks
 
 ## Notebook
-Where you will store notes.
+Where you will store notes
 
 ## Example
 Basic case scenario, where:  
@@ -100,4 +110,11 @@ notes -w workspace_name
 Switching workspace and creating a note there
 ```bash
 notes -w workspace_name -n notebook note_title
-```
+```
+
+## Help
+Display available commands
+
+```bash
+notes --help
+```

data/lib/notes_cli.rb

@@ -6,8 +6,6 @@ module NotesCli
   CONFIG_PATH = File.join(LIBRARY, 'config.yml')
 end
 
-require 'pry'
-require 'pry-byebug'
 require 'yaml'
 require 'fileutils'
 require 'optparse'

data/lib/notes_cli/controllers/option_parser.rb

@@ -8,11 +8,11 @@ if ARGV.empty?
 end
 
 OptionParser.new do |opt|
-  opt.on('-n --new_note TITLE PATH/TO/FILE') { |option| workspace.create_note(option, ARGV) }
+  opt.on('-n --new_note NOTEBOOK NOTE_TITLE') { |option| workspace.create_note(option, ARGV) }
 
-  opt.on('-d --delete_note TITLE PATH/TO/FILE ') { |option| workspace.delete_note(option, ARGV) }
+  opt.on('-d --delete_note NOTEBOOK NOTE_TITLE ') { |option| workspace.delete_note(option, ARGV) }
 
-  opt.on('-l --list_notes TITLE PATH/TO/NOTEBOOK') do |option|
+  opt.on('-l --list_notes NOTEBOOK NOTE_TITLE') do |option|
     workspace.list_notes(option)
   end
 

data/lib/notes_cli/services/note_lister.rb

@@ -14,6 +14,8 @@ class NoteLister
     empty_notebook_notification
   end
 
+  private
+
   def handle_errors
     raise StandardError, 'no such notebook' unless notebook_exists?(@notebook)
   end

data/lib/notes_cli/version.rb

@@ -1,3 +1,3 @@
 module NotesCli
-  VERSION = '0.1.0'
+  VERSION = '0.1.5'
 end

data/notes_cli.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.executables << 'notes'
   s.require_paths = ['lib']
   s.homepage    =
-    'https://rubygems.org/gems/notes_cli'
+    'https://github.com/joe-at-github/notes_cli'
   s.license       = 'MIT'
   s.add_development_dependency 'fakefs', '~> 0.5'
   s.add_development_dependency 'pry', '~> 0.12'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notes_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Joeffrey Lamy
@@ -110,8 +110,6 @@ files:
 - LICENSE.txt
 - README.md
 - bin/notes
-- config.db
-- config.yml.db
 - lib/notes_cli.rb
 - lib/notes_cli/controllers/option_parser.rb
 - lib/notes_cli/models/workspace.rb
@@ -123,7 +121,7 @@ files:
 - lib/notes_cli/services/services.rb
 - lib/notes_cli/version.rb
 - notes_cli.gemspec
-homepage: https://rubygems.org/gems/notes_cli
+homepage: https://github.com/joe-at-github/notes_cli
 licenses:
 - MIT
 metadata: {}