create_awesome_readme 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8e57179de1850594634204e237286040a5634f4
+  data.tar.gz: 617bd48e029b4d717368835293a572a9f92f76b3
+SHA512:
+  metadata.gz: 71c93913bbc52bb6a47980c494086489b4ff95c04fd4dfa061d99634c927c17b302c11e5fb32ef364771455fbad55ef87a307bdbb3ad397cc138c511474a5067
+  data.tar.gz: 87ff7a0bb90aa61dcb7afa2b697012857b69b883aa20ff0e5ec8132c4450c8b8143169dcd478f85e1e86e33155f0b07fee6f20b8c6a6536fff0a7610f710dbad

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in create_awesome_readme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stephen Giles
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# CreateAwesomeReadme
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'create_awesome_readme'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install create_awesome_readme
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/create_awesome_readme/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/create_awesome_readme

@@ -0,0 +1,7 @@
+#!usr/bin/env ruby
+
+require 'create_awesome_readme'
+
+run = CreateAwesomeReadme.new
+run.create_new
+run.add_contents

data/create_awesome_readme.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'create_awesome_readme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "create_awesome_readme"
+  spec.version       = CreateAwesomeReadme::VERSION
+  spec.authors       = ["Stephen Giles"]
+  spec.email         = [""]
+  spec.summary       = "A gem to create awesome README.md on GitHub"
+  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."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/create_awesome_readme/version.rb

@@ -0,0 +1,3 @@
+class CreateAwesomeReadme
+  VERSION = "0.0.2"
+end

data/lib/create_awesome_readme.rb

@@ -0,0 +1,11 @@
+require_relative "create_awesome_readme/version"
+
+class CreateAwesomeReadme
+  def create_new
+    system "touch README.md"
+  end
+
+  def add_contents
+    system "cat template.txt > README.md"
+  end
+end

data/spec/create_awesome_readme_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe CreateAwesomeReadme do
+
+  let(:readme){CreateAwesomeReadme.new}
+
+  # it 'should create a blank file' do
+  #   readme.create_new
+  #   expect(File).to exist("./in_here/an_awesome_readme.md")
+  # end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'create_awesome_readme'
+

data/tasks/rspec.rake

@@ -0,0 +1,2 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/template.txt

@@ -0,0 +1,42 @@
+Title
+=======================
+
+## Synopsis
+
+TODO: Enter a description of your project here.
+
+![NAME_OF_IMAGE](http://ENTER_URL)
+
+## Technologies Used
+
+- LANGUAGE_ONE
+- LANGUAGE_TWO
+- FRAMEWORK
+- TESTING SUITES
+
+## Job List
+
+- [ ]
+- [ ]
+- [ ]
+- [ ]
+
+## Favourite Code Snippet
+
+~~~
+ TODO: paste code here
+~~~
+
+## Collaborators
+
+- NAME_ONE (http://www.github.com/USERNAME)
+- NAME_TWO (http://www.github.com/USERNAME)
+
+## Still to complete/refactor
+
+- [ ]
+- [ ]
+
+## Takeaway
+
+TODO: Enter a personal reflection and/or things you learnt

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: create_awesome_readme
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stephen Giles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email:
+- ''
+executables:
+- create_awesome_readme
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/create_awesome_readme
+- create_awesome_readme.gemspec
+- in_here/.DS_Store
+- lib/create_awesome_readme.rb
+- lib/create_awesome_readme/version.rb
+- spec/create_awesome_readme_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- template.txt
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to create awesome README.md on GitHub
+test_files:
+- spec/create_awesome_readme_spec.rb
+- spec/spec_helper.rb