rbforge 0.1.6 → 0.1.7

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 (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +34 -18
  3. data/lib/rbforge/version.rb +1 -1
  4. data/lib/rbforge.rb +2 -2
  5. data/rbforge-0.1.6.gem +0 -0
  6. metadata +2 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8460c428c176c3e9333485247f77234fcc38045da3a2f6f851186d3f0b1837b5
4
- data.tar.gz: cd6a7f9a831715eb2f52922eb6058fb8c1853757d9ecebffef35a7b0f582eae1
3
+ metadata.gz: 6c758b7fcb0e75a7d0065bdbac68a026de72d02eeaa107e627713c807c033142
4
+ data.tar.gz: 9ade6fc5e7050250b8d4ddc564a8a1c8cd59ab67b69b283925f3239d025f809a
5
5
  SHA512:
6
- metadata.gz: 2f902fcae009a3c90a91c30179cf1109fb96e2ae9bd602f3f496a7d314c58d6b89c3cb6f62b6eaae4abfd5d8548903b3263aafa775f0ad6b807c63606fc2e7b1
7
- data.tar.gz: fec2db0646bf4bc94836fcc1fb12def411fa6e947a0cd84337dd0df4eb32cd154108d93e079c8a68a26fb50c8a86586debb70c26fa511b226721b32273298dc0
6
+ metadata.gz: 62997fd9fc705f4f3356367321dc90597197af6ffb29940614f68a7734d7a3e4cb3001315d8affde49100708cba837af218f6cdc0687a2c7f6e51a48e57a69e6
7
+ data.tar.gz: 436308db732a0cb17b10b43fcc1a140d958c6eae08ef1a3a547def651c27567297e1648449babf1736687709bc3c3d81dcb59ca32e7e329c03ca10b5d18c49db
data/README.md CHANGED
@@ -1,39 +1,55 @@
1
1
  # Rbforge
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ Rbforge is a CLI gem that helps you quickly start Ruby projects by automatically generating essential files such as `README.md`, `Gemfile`, `src/`, and more.
4
4
 
5
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbforge`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+ Perfect for Ruby developers who want to standardize or accelerate the creation of new gems or plain Ruby projects.
6
6
 
7
- ## Installation
7
+ <br>
8
8
 
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
9
+ ## ✨ Features
10
10
 
11
- Install the gem and add to the application's Gemfile by executing:
11
+ - Automatically generates basic files:
12
+ `README.md`, `Gemfile`, `src/main.rb`
13
+ - Quick Ruby project scaffolding
14
+ - Terminal interface (`rbforge` command)
15
+
16
+ <br>
17
+
18
+ ## 💾 Installation
19
+
20
+ Add to your project with:
12
21
 
13
22
  ```bash
14
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
23
+ bundle add rbforge
15
24
  ```
16
25
 
17
- If bundler is not being used to manage dependencies, install the gem by executing:
26
+ Or install it directly:
18
27
 
19
28
  ```bash
20
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
29
+ gem install rbforge
21
30
  ```
22
31
 
23
- ## Usage
24
-
25
- TODO: Write usage instructions here
32
+ Create a new Ruby project structure with inside of your project folder:
26
33
 
27
- ## Development
34
+ ```bash
35
+ rbforge init
36
+ ```
28
37
 
29
- After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
38
+ This will create a project with the default starter structure:
30
39
 
31
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
40
+ ```
41
+ my_project/
42
+ ├── .gitignore
43
+ ├── Gemfile
44
+ ├── README.md
45
+ └── src/
46
+ └── main.rb
47
+ ```
32
48
 
33
- ## Contributing
49
+ You can then edit the files as needed and begin development right away.
34
50
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbforge.
51
+ <br>
36
52
 
37
- ## License
53
+ # License
54
+ This gem is available as open source under the terms of the MIT License.
38
55
 
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/lib/rbforge/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Rbforge
4
- VERSION = "0.1.6"
4
+ VERSION = "0.1.7"
5
5
  end
data/lib/rbforge.rb CHANGED
@@ -18,11 +18,11 @@ module Rbforge
18
18
  def self.init_c
19
19
  puts "[*] - FORGING your ruby project..."
20
20
 
21
- FileUtils.mkdir_p('lib')
21
+ FileUtils.mkdir_p('src')
22
22
  FileUtils.touch('Gemfile')
23
23
  FileUtils.touch('README.md')
24
24
  FileUtils.touch('.gitignore')
25
- FileUtils.touch('lib/main.rb')
25
+ FileUtils.touch('src/main.rb')
26
26
 
27
27
  File.open('Gemfile', "w") do |g_file|
28
28
  g_file.puts 'source "https://rubygems.org"'
data/rbforge-0.1.6.gem ADDED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rbforge
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.6
4
+ version: 0.1.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - mvghasty
@@ -23,6 +23,7 @@ files:
23
23
  - exe/rbforge
24
24
  - lib/rbforge.rb
25
25
  - lib/rbforge/version.rb
26
+ - rbforge-0.1.6.gem
26
27
  - sig/rbforge.rbs
27
28
  homepage: https://github.com/mvghasty/rbforge
28
29
  licenses: