create_awesome_readme 0.0.2
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.
- checksums.yaml +7 -0
- data/.DS_Store +0 -0
- data/.gitignore +14 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +31 -0
- data/Rakefile +3 -0
- data/bin/create_awesome_readme +7 -0
- data/create_awesome_readme.gemspec +24 -0
- data/in_here/.DS_Store +0 -0
- data/lib/create_awesome_readme/version.rb +3 -0
- data/lib/create_awesome_readme.rb +11 -0
- data/spec/create_awesome_readme_spec.rb +12 -0
- data/spec/spec_helper.rb +2 -0
- data/tasks/rspec.rake +2 -0
- data/template.txt +42 -0
- metadata +106 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: d8e57179de1850594634204e237286040a5634f4
|
4
|
+
data.tar.gz: 617bd48e029b4d717368835293a572a9f92f76b3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 71c93913bbc52bb6a47980c494086489b4ff95c04fd4dfa061d99634c927c17b302c11e5fb32ef364771455fbad55ef87a307bdbb3ad397cc138c511474a5067
|
7
|
+
data.tar.gz: 87ff7a0bb90aa61dcb7afa2b697012857b69b883aa20ff0e5ec8132c4450c8b8143169dcd478f85e1e86e33155f0b07fee6f20b8c6a6536fff0a7610f710dbad
|
data/.DS_Store
ADDED
Binary file
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Stephen Giles
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# CreateAwesomeReadme
|
2
|
+
|
3
|
+
TODO: Write a gem description
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'create_awesome_readme'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install create_awesome_readme
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
TODO: Write usage instructions here
|
24
|
+
|
25
|
+
## Contributing
|
26
|
+
|
27
|
+
1. Fork it ( https://github.com/[my-github-username]/create_awesome_readme/fork )
|
28
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
29
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
30
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
31
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'create_awesome_readme/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "create_awesome_readme"
|
8
|
+
spec.version = CreateAwesomeReadme::VERSION
|
9
|
+
spec.authors = ["Stephen Giles"]
|
10
|
+
spec.email = [""]
|
11
|
+
spec.summary = "A gem to create awesome README.md on GitHub"
|
12
|
+
spec.description = "This is an attempt to create a gem which helps GitHub users to create good README.md files. It should help them create consistent and detailed READMEs with a template which they edit with appropriate details."
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
22
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
23
|
+
spec.add_development_dependency "rspec"
|
24
|
+
end
|
data/in_here/.DS_Store
ADDED
Binary file
|
data/spec/spec_helper.rb
ADDED
data/tasks/rspec.rake
ADDED
data/template.txt
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
Title
|
2
|
+
=======================
|
3
|
+
|
4
|
+
## Synopsis
|
5
|
+
|
6
|
+
TODO: Enter a description of your project here.
|
7
|
+
|
8
|
+

|
9
|
+
|
10
|
+
## Technologies Used
|
11
|
+
|
12
|
+
- LANGUAGE_ONE
|
13
|
+
- LANGUAGE_TWO
|
14
|
+
- FRAMEWORK
|
15
|
+
- TESTING SUITES
|
16
|
+
|
17
|
+
## Job List
|
18
|
+
|
19
|
+
- [ ]
|
20
|
+
- [ ]
|
21
|
+
- [ ]
|
22
|
+
- [ ]
|
23
|
+
|
24
|
+
## Favourite Code Snippet
|
25
|
+
|
26
|
+
~~~
|
27
|
+
TODO: paste code here
|
28
|
+
~~~
|
29
|
+
|
30
|
+
## Collaborators
|
31
|
+
|
32
|
+
- NAME_ONE (http://www.github.com/USERNAME)
|
33
|
+
- NAME_TWO (http://www.github.com/USERNAME)
|
34
|
+
|
35
|
+
## Still to complete/refactor
|
36
|
+
|
37
|
+
- [ ]
|
38
|
+
- [ ]
|
39
|
+
|
40
|
+
## Takeaway
|
41
|
+
|
42
|
+
TODO: Enter a personal reflection and/or things you learnt
|
metadata
ADDED
@@ -0,0 +1,106 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: create_awesome_readme
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.2
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Stephen Giles
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-11-18 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: This is an attempt to create a gem which helps GitHub users to create
|
56
|
+
good README.md files. It should help them create consistent and detailed READMEs
|
57
|
+
with a template which they edit with appropriate details.
|
58
|
+
email:
|
59
|
+
- ''
|
60
|
+
executables:
|
61
|
+
- create_awesome_readme
|
62
|
+
extensions: []
|
63
|
+
extra_rdoc_files: []
|
64
|
+
files:
|
65
|
+
- ".DS_Store"
|
66
|
+
- ".gitignore"
|
67
|
+
- Gemfile
|
68
|
+
- LICENSE.txt
|
69
|
+
- README.md
|
70
|
+
- Rakefile
|
71
|
+
- bin/create_awesome_readme
|
72
|
+
- create_awesome_readme.gemspec
|
73
|
+
- in_here/.DS_Store
|
74
|
+
- lib/create_awesome_readme.rb
|
75
|
+
- lib/create_awesome_readme/version.rb
|
76
|
+
- spec/create_awesome_readme_spec.rb
|
77
|
+
- spec/spec_helper.rb
|
78
|
+
- tasks/rspec.rake
|
79
|
+
- template.txt
|
80
|
+
homepage: ''
|
81
|
+
licenses:
|
82
|
+
- MIT
|
83
|
+
metadata: {}
|
84
|
+
post_install_message:
|
85
|
+
rdoc_options: []
|
86
|
+
require_paths:
|
87
|
+
- lib
|
88
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
89
|
+
requirements:
|
90
|
+
- - ">="
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: '0'
|
93
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
94
|
+
requirements:
|
95
|
+
- - ">="
|
96
|
+
- !ruby/object:Gem::Version
|
97
|
+
version: '0'
|
98
|
+
requirements: []
|
99
|
+
rubyforge_project:
|
100
|
+
rubygems_version: 2.2.2
|
101
|
+
signing_key:
|
102
|
+
specification_version: 4
|
103
|
+
summary: A gem to create awesome README.md on GitHub
|
104
|
+
test_files:
|
105
|
+
- spec/create_awesome_readme_spec.rb
|
106
|
+
- spec/spec_helper.rb
|