til-rb 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0027d094b71d1fa0d6f5e44cba6156437c0f9dea43db6975e4dae481d71836
-  data.tar.gz: 60d850a49f82d03580d8bcba303ee7a7fdf9dd099037c17947bdc86f19163ee0
+  metadata.gz: c97869d1c32d177ee5086d135865e9d21145e754d09a3542dbeb0558d10121ba
+  data.tar.gz: 100e0765c9ad27450614b785d2099794ee674425c2e35b6128b9bffaf9873836
 SHA512:
-  metadata.gz: ea9f23f36f457bdbb0c75dfb8bdb3040ea2b77e65d29c7bf046aa7b94b45ac525d64984c3c2f74a02f794a60161d56baeab2143913a4865b4b2cb112da10e163
-  data.tar.gz: 1a0dc250f4939160acf604d1869cef37325427c155510c44ace0c1a335a331c8945d0d9b8ebe34334d310a1e4bd147662fdb5ccbec65c741ec32fcabb903b6dc
+  metadata.gz: bb6b75930c31b17a85a18229561e96cd4843c65f03cf8a2f9e43a7d0566d512cd50965ce86806091ceda929774aa9c7b6dc3576dec1c7be293a15c45f9af264b
+  data.tar.gz: 987ddd76bf8394424e404f776837301d70477907f8bdb4387bae61af2fcb00a3f15522b1629f14c81f6fac741a81f1f2d2a92a358518e4127a9f79741c01335e

data/README.md

@@ -5,3 +5,56 @@
 A work-in-progress tool to maintain a TIL repo.
 
 Inspiration: https://github.com/jbranchaud/til
+
+See it in action below:
+
+![til in action](til.gif)
+
+## Installation
+
+### Step 1: Install the gem
+
+```
+gem install til-rb
+```
+
+### Step 2: Create a GitHub repo
+
+You need a GitHub repo to store your TILs. The gem has pretty strict expectations about the format of the README.md
+file, so I recommend forking [this repo](https://github.com/pjambet/til-template), or just copying the content to a
+fresh new repo.
+
+Note: The format expectations mentioned above are the following:
+
+- A "categories" section as defined by a leading markdown separator `---`, followed by a blank line, the `###
+  Categories` title, and a list of all the categories.
+- A links section as defined by a leading markdown separator `---`, followed by a blank line and a series of markdown
+  titles for each categories present in the previous section.
+
+### Step 3: Add the environment variables
+
+Add the following variables to your environment:
+
+- `GH_TOKEN`: The only required scope is `public_repo` if your TIL repo is public and `repo` if it is private. You can
+  create a token [in the GitHub
+  settings](https://github.com/settings/tokens/new?scopes=public_repo&description=Token%20for%20til-rb)
+- `GH_REPO`: The repo name, e.g. `pjambet/til`
+
+You might want to add those to either your `.bashrc` or `.zshrc` but please be careful in case you share those publicly
+as the token is private and *must not* be shared publicly.
+
+### Step 4:
+
+Run `til` from the command line
+
+## Future improvements
+
+- An `init` command that will create a repo for you
+- A `configure` command that will store the token and the repo name in a file in `~/.config/til/config` or `~/.til`
+
+## Known issues
+
+The current version (0.0.5) deletes the temporary file before attempting to create the new commit, so if anything goes
+wrong there, the content of the file will be lost.
+This will be fixed soon, by only deleting the temporary file after the commit was created, but please keep that in mind
+if you typed a long TIL and definitely don't want to lose its content.

data/bin/til

@@ -7,7 +7,7 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = 'Usage: til [options]'
 
-  opts.on('-tTITLE', '--titleTITLE', 'Set the title from the command line') do |title|
+  opts.on('-t', '--title=TITLE', 'Set the title from the command line') do |title|
     options[:title] = title
   end
 

data/lib/til/core.rb

@@ -163,8 +163,8 @@ module Til
       commit = github_client.create_commit repo_name, commit_title, tree.sha, ref.object.sha
       github_client.update_ref repo_name, 'heads/master', commit.sha
 
-      puts "You can see your new TIL at : https://github.com/pjambet/til/blob/master/#{category}/#{filename}"
-      puts "You can edit your new TIL at : https://github.com/pjambet/til/edit/master/#{category}/#{filename}"
+      puts "You can see your new TIL at : https://github.com/#{repo_name}/blob/master/#{category}/#{filename}"
+      puts "You can edit your new TIL at : https://github.com/#{repo_name}/edit/master/#{category}/#{filename}"
     end
 
     def update_readme_content(category, commit_title, filename, readme_content)

data/lib/til/version.rb

@@ -1,5 +1,5 @@
 module Til
 
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: til-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Pierre Jambet
@@ -66,7 +66,7 @@ files:
 - lib/til/core.rb
 - lib/til/readme_updater.rb
 - lib/til/version.rb
-homepage: https://rubygems.org/gems/til-rb
+homepage: https://github.com/pjambet/til-rb/
 licenses:
 - MIT
 metadata: {}