chchchanges 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/.changelog_entries/2016_12_22_1608_v0.1.1.json +1 -0
  3. data/CHANGELOG.md +4 -0
  4. data/README.md +7 -1
  5. data/chchchanges.gemspec +3 -1
  6. data/lib/chchchanges/version.rb +1 -1
  7. metadata +4 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 02e6a1cfe609c3ca5b4ee80e93aaee9f88e466a2
4
- data.tar.gz: ceb6cbc827e904f7600c03b134b3037688afdf1e
3
+ metadata.gz: 54cb197b5676b2775d1b57b1bf8b5c55abed73cf
4
+ data.tar.gz: 98b38e1515dc399b14e1b6836eec9560d4931f93
5
5
  SHA512:
6
- metadata.gz: 6307ec5cc81dfa4e195693e8b35aef7222614a61f4309ca8badbf499bfa107a1d629bb4ba56ce27e05027fadadbbf741b07488c525b89810840f38929d089fcf
7
- data.tar.gz: 042d90017b3b30d6ee013c859914c2f7e5968e07064db5eaf52637d0f71d85dd0270d9ac50a40657214c5fc835efc1cb16cbb14ffd5848ee643aebe5ed296734
6
+ metadata.gz: c2858b8779909f4aeb54e4dd0cd802674e9158e22c8051f89c754d681fb0f3d765a229fb2ae658e8ab45495920d676d0f87bdb6b285331978c19e7dfd8a48e44
7
+ data.tar.gz: 45f38a478376d6d1cd582e52425f2b406acb39f8007b19d29120732138aba77a341d568ab4448910d8a0f589bfefde6190225f506da8282123cde80d3a27e37a
data/.changelog_entries/2016_12_22_1608_v0.1.1.json ADDED
@@ -0,0 +1 @@
1
+ {"type":"Added","ticket":"","url":"","description":"Added a 'usage' section to the README","version":"0.1.1","tags":[]}
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Change Log
2
2
 
3
+ ## [0.1.1]
4
+ ### Added
5
+ - [] Added a 'usage' section to the README
6
+
3
7
  ## [0.1.0]
4
8
  ### Added
5
9
  - [] Initial functionality with CHANGELOG entry, generator, and parser features
data/README.md CHANGED
@@ -1,3 +1,4 @@
1
+ *turn and face the strange*
1
2
  # Chchchanges
2
3
 
3
4
  ### chchchanges makes it convenient to create and maintain a proper CHANGELOG.
@@ -23,7 +24,12 @@ Or install it yourself as:
23
24
 
24
25
  ## Usage
25
26
 
26
- TODO: Write usage instructions here
27
+ When starting a changelog from scratch, simply use the command `$ chchchanges -e` and
28
+ follow the prompts to create a changelog entry. Than command will create a .json file with the changelog entry data. The file name will be unique, thereby ensuring that future changelog entries will not result in git merge conflicts. Every time you generate a changelog entry with the `chchchanges -e` command, a new unique file is created.
29
+
30
+ ### *But now I have a bunch of .json files with changelog data, and I want to have a nice CHANGELOG.md document*
31
+
32
+ To generate a CHANGELOG.md document from your .json changelog entry files, run the command `$ chchchanges -g`
27
33
 
28
34
  ## Development
29
35
 
data/chchchanges.gemspec CHANGED
@@ -12,7 +12,9 @@ Gem::Specification.new do |spec|
12
12
  spec.summary = %q{chchchanges makes it convenient to create and maintain a proper CHANGELOG.}
13
13
  spec.description = %q{chchchanges makes it convenient to create and maintain a proper CHANGELOG.
14
14
  Users can create CHANGELOG entries from the command line. Each entry is saved
15
- as in individual .json file which prevents CHANGELOG merge conflicts.}
15
+ as in individual .json file which prevents CHANGELOG merge conflicts.
16
+ For more info, check out the README or inspect the code at
17
+ https://github.com/EricJZell/chchchanges}
16
18
  spec.homepage = "https://github.com/EricJZell/chchchanges"
17
19
  spec.license = "MIT"
18
20
 
data/lib/chchchanges/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Chchchanges
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chchchanges
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Eric Zell
@@ -56,6 +56,8 @@ description: |-
56
56
  chchchanges makes it convenient to create and maintain a proper CHANGELOG.
57
57
  Users can create CHANGELOG entries from the command line. Each entry is saved
58
58
  as in individual .json file which prevents CHANGELOG merge conflicts.
59
+ For more info, check out the README or inspect the code at
60
+ https://github.com/EricJZell/chchchanges
59
61
  email:
60
62
  - ericjzell@gmail.com
61
63
  executables:
@@ -64,6 +66,7 @@ extensions: []
64
66
  extra_rdoc_files: []
65
67
  files:
66
68
  - ".changelog_entries/1192b2e6cfb3c57360e4a90adb105f24.json"
69
+ - ".changelog_entries/2016_12_22_1608_v0.1.1.json"
67
70
  - ".changelog_entries/66dcb740d4c86e3ba889d7831baf7d30.json"
68
71
  - ".gitignore"
69
72
  - ".rspec"