lessons_indexer 0.0.2.1 → 0.0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6f88831e8ce052dcc32bb7fa5dee852704b3133
-  data.tar.gz: c12ce22e7c5ef3750693ad4899bff238f6f8271f
+  metadata.gz: 700b6b45e2dcbff289222f9c44f1eaea2fcb9997
+  data.tar.gz: 156538d022744cc4520352f90ca375e76266a288
 SHA512:
-  metadata.gz: 5e7f484749590e07157356103a05129e93f6be49eda8bcacfb55842145274947a44e03847518460c7426cc14f662f4b85b5da39be35aef5ec4f79ec0631361ad
-  data.tar.gz: 890cae777e1935c86f9a9ce626f88840adc19e905ff613789c4cb9c0dab9b11aae8e9779fcec0e2922363db8f85aa40251333f6e92991ee73a77eeb9604b1bd6
+  metadata.gz: e6dec8a959a6ab12f203001e164ffd0cf3836bc090c64853078fa18c9417dab332d6c2fbb4629111128ad01fb794b4cfe0dfb1a62f1fb7df1e8b4b157ee9cd20
+  data.tar.gz: 02fae34b5d7415b1b8d4a476e873b49e5132cf4224af35966fb0e34304e919a938ff0b8ff08cf2c3eea904bee706388bda5ecba26b7cde854c7feedcf0c80e3e

data/.gitignore

@@ -1,3 +1,3 @@
 Gemfile.lock
 .idea/
-test.txt
+*.gem

data/README.md

@@ -4,47 +4,53 @@
 [![Dependency Status](https://gemnasium.com/bodrovis/LessonsIndexer.svg)](https://gemnasium.com/bodrovis/LessonsIndexer)
 # Lessons Indexer for Learnable
 
-Builds an index in Markdown format for the lesson files in the provided directory and optionally adds heading images to the files. Available options:
+Builds an index in Markdown format for the lesson files in the provided directory, adds heading images to the files,
+pushes changes to GitHub. Can work with multiple branches.
 
-* `-p` (`--path`) - path to the working directory. Defaults to `.`.
-* `-s` (`--skip_index`) - skip index generation. Defaults to `false`.
-* `-o` (`--output`) - output file to save index to. Defaults to `README.md`. The file will be creating in the working
-directory if it does not exist. If it does exist, all its contents **will be erased**. Has no effect if `-s` is set.
-* `-g` (`--git`) - if present, pushes changes to the remote branch (with the name equal to the local branch).
-* `-m` (`--message`) - which commit message should be specified. Default to "Added index". Has no effect if the `-g` flag
-is not set.
-* `-a` (`--all`) - if present, will work with **all** branches of the specified directory (except for `master`).
-* `-i` (`--headings`) - if present, heading images will be added to the beginning of each lesson file. If the file already
-has a heading in the beginning, it will be skipped.
-* `-d` (`--headings_dir`) - relative path to the directory with heading images.
-Defaults to `headers`, has no effect if the `-i` flag is not set.
+## Installation and Usage
 
-## Running
+Requires [Ruby](https://www.ruby-lang.org) 2.0+ and [RubyGems](https://rubygems.org/). `Ruby\bin` should be added
+to the PATH.
 
-Requires Ruby 2.0+. Install the necessary gems using
+Install the gem:
 
 ```
-bundle install
+gem install lessons_indexer
 ```
 
-To run on nix systems use
+Run:
 
 ```
-bin/lessons_indexer <options>
+lessons_indexer <options>
 ```
 
-For Windows use
+or 
 
 ```
-bin/lessons_indexer.bat <options>
+bundle exec lessons_indexer <options>
 ```
 
-If any option's value contains spaces, it has to be surrounded with quotes:
+If an option contains spaces, it has to be surrounded with quotes:
 
 ```
 bin/lessons_indexer -p "C:\User\my test dir\"
 ```
 
+## Options
+
+* `-p` (`--path`) - path to the working directory. Defaults to `.`.
+* `-s` (`--skip_index`) - skip index generation. Defaults to `false`.
+* `-o` (`--output`) - output file to save index to. Defaults to `README.md`. The file will be creating in the working
+directory if it does not exist. If it does exist, all its contents **will be erased**. Has no effect if `-s` is set.
+* `-g` (`--git`) - if present, pushes changes to the remote branch (with the name equal to the local branch).
+* `-m` (`--message`) - which commit message should be specified. Default to "Added index". Has no effect if the `-g` flag
+is not set.
+* `-a` (`--all`) - if present, will work with **all** branches of the specified directory (except for `master`).
+* `-i` (`--headings`) - if present, heading images will be added to the beginning of each lesson file. If the file already
+has a heading in the beginning, it will be skipped.
+* `-d` (`--headings_dir`) - relative path to the directory with heading images.
+Defaults to `headers`, has no effect if the `-i` flag is not set.
+
 ## Some Assumptions
 
 Here are some guidelines to follow when using the program:
@@ -64,6 +70,7 @@ this step will be just skipped and the corresponding warning message will be dis
 ## Testing
 
 ```
+bundle install
 rspec .
 ```
 

data/lessons_indexer.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = ["lessons_indexer"]#spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = ["lessons_indexer"]
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 

data/lib/lessons_indexer/version.rb

@@ -1,3 +1,3 @@
 module LessonsIndexer
-  VERSION = "0.0.2.1"
+  VERSION = "0.0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lessons_indexer
 version: !ruby/object:Gem::Version
-  version: 0.0.2.1
+  version: 0.0.2.2
 platform: ruby
 authors:
 - Ilya Bodrov