konkit_worklogger 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e32fb8f5819a91cc824775e141bf9024ba48693b7996ca2db32c4498d95d8e76
-  data.tar.gz: c86267887802a77e7e066d4ed0893128fd54af7c9b0b7c011fc2a53c1b050b1a
+  metadata.gz: 3cf49d4918f2364b8a2836f73f6c36ab84ec0d04ab27c1ed501b85a29ae6260d
+  data.tar.gz: b81363e32f818f83267965c17572ad65df6273de073b88debb082ad5fa438ef1
 SHA512:
-  metadata.gz: 5af58d33ff266cd36ea0c5cb6b7cc6616d7dd21e644a014b0eac70376ec0b1e8c8d025ae4b235bebfcc32ebeca74d6c7ece49657db28b2cd9fcf1e631b504628
-  data.tar.gz: a6fa0033fb081ffd0bcff35ab2688d00899b677e734a96e65b593315bb8628a9f3400ad5eeb8ab4d9e4d28f0c02c6fd2b0596f66825022526e9c32d81976a343
+  metadata.gz: cf314df990e17989eaf777a82ea72e2f1215bd396dca2a3a58eaca0f481a65496bebf7d477f93b87534a523f1845ddf7bf5bb53eb4b9b873e911f63ef43d7d4e
+  data.tar.gz: b8b023f165c60a6d6e5714a01dd8ff901a08571285989f90337d129e2f4214441f2fe6df27a1d22531b0cb78d0fa6b1c9c4df6db696323346f01c7a5f4bcd8c4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    konkit_worklogger (0.1.0)
+    konkit_worklogger (0.1.3)
       thor (~> 1.0)
 
 GEM

data/README.md

@@ -9,3 +9,61 @@ Therefore all you need to care about is to turn your computer off when you finis
 Under the hood, it writes a new line to a file each minute (scheduled by cron).
 Then, it gathers all those "minutes" to calculate your work time.
 Because of that, it works even if you have to pause the work for some time - you just need to turn the computer off.
+
+
+# Installation
+
+### Step 0 - if you use RVM - setup the correct ruby version
+
+```
+rvm use ...
+```
+
+### Step 1 - install the gem
+
+```
+gem install konkit-worklogger
+```
+
+
+### Step 2 - create the config file with a folder with your entries
+```
+echo "path: \"$HOME/.konkit_worklogger/timeentries\"" > $HOME/.konkit_worklogger/config.yml
+```
+
+### Step 3 - setup the Cron job
+First, we have to run the `rvm cron setup` command to fill our cron file with needed variables.
+
+```
+rvm cron setup 
+```
+
+Then, we have to edit the cron file and add the worklogger command
+
+```
+crontab -e
+```
+
+Add the following line there:
+
+
+```
+* * * * * $MY_RUBY_HOME/bin/ruby $GEM_HOME/bin/worklogger increment
+```
+
+
+# Usage 
+To display the help screen, run:
+```
+worklogger
+```
+
+To display today's entries, run:
+```
+worklogger today
+```
+
+To display the entries for the whole month with carry from previous months, run: 
+```
+worklogger month
+```

data/lib/konkit_worklogger/configuration.rb

@@ -4,14 +4,15 @@ require 'fileutils'
 class WorkLoggerConfiguration
   attr_reader :worklogger_path
 
-  def initialize(worklogger_path, config_path = nil)
+  def initialize(worklogger_path)
     @worklogger_path = worklogger_path
-    @config_path = config_path || '%s/.konkit_worklogger/config.yml' % Dir.home
   end
 
   def self.load
-    conf = if File.file?(@config_path)
-             config_file_content = IO.read(@config_path)
+    config_path = '%s/.konkit_worklogger/config.yml' % Dir.home
+
+    conf = if File.file?(config_path)
+             config_file_content = IO.read(config_path)
              config = YAML.safe_load(config_file_content)
 
              worklogger_path = config['path']

data/lib/konkit_worklogger/version.rb

@@ -1,3 +1,3 @@
 module KonkitWorklogger
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konkit_worklogger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Łukasz Tenerowicz
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Worklogger