rbforge 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8460c428c176c3e9333485247f77234fcc38045da3a2f6f851186d3f0b1837b5
-  data.tar.gz: cd6a7f9a831715eb2f52922eb6058fb8c1853757d9ecebffef35a7b0f582eae1
+  metadata.gz: '07811f4475e27e0c4182cf7c1d3a5df44f1760e2a0483fa477ca95a96cd3600c'
+  data.tar.gz: 88c4ebe22c1184add0f4f0d6a337ebd6847db3b095e1903b2fb447a7f058b236
 SHA512:
-  metadata.gz: 2f902fcae009a3c90a91c30179cf1109fb96e2ae9bd602f3f496a7d314c58d6b89c3cb6f62b6eaae4abfd5d8548903b3263aafa775f0ad6b807c63606fc2e7b1
-  data.tar.gz: fec2db0646bf4bc94836fcc1fb12def411fa6e947a0cd84337dd0df4eb32cd154108d93e079c8a68a26fb50c8a86586debb70c26fa511b226721b32273298dc0
+  metadata.gz: a2a55f759ba795dfc14637e9358146c364d9a0f133feada3e47d4b35814b857e03175cde0555ac1293155c1b5efeac44f6e5610e134dc7115adb5df9006a9fae
+  data.tar.gz: e1464e261fb8ce3251b25a81da10b2e9a627e9f93b67c808318bc216044fc8ccb6b0bfef51aac485c2ea8e12a6bbe670eb3179ed7164c95dae3aa4a4675ee994

data/README.md

@@ -1,39 +1,55 @@
 # Rbforge
 
-TODO: Delete this and the text below, and describe your gem
+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.
 
-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.
+Perfect for Ruby developers who want to standardize or accelerate the creation of new gems or plain Ruby projects.
 
-## Installation
+<br>
 
-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.
+## ✨ Features
 
-Install the gem and add to the application's Gemfile by executing:
+- Automatically generates basic files:  
+  `README.md`, `Gemfile`, `src/main.rb`
+- Quick Ruby project scaffolding
+- Terminal interface (`rbforge` command)
+
+<br>
+
+## 💾 Installation
+
+Add to your project with:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add rbforge
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it directly:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install rbforge
 ```
 
-## Usage
-
-TODO: Write usage instructions here
+Create a new Ruby project structure with inside of your project folder:
 
-## Development
+```bash
+rbforge init
+```
 
-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.
+This will create a project with the default starter structure:
 
-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).
+```
+my_project/
+├── .gitignore
+├── Gemfile
+├── README.md
+└── src/
+    └── main.rb
+```
 
-## Contributing
+You can then edit the files as needed and begin development right away.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbforge.
+<br>
 
-## License
+# License
+This gem is available as open source under the terms of the MIT License.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rbforge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rbforge
-  VERSION = "0.1.6"
+  VERSION = "0.1.8"
 end

data/lib/rbforge.rb

@@ -18,17 +18,17 @@ module Rbforge
     def self.init_c
       puts "[*] - FORGING your ruby project..."
 
-      FileUtils.mkdir_p('lib')
+      FileUtils.mkdir_p('src')
       FileUtils.touch('Gemfile')
       FileUtils.touch('README.md')
       FileUtils.touch('.gitignore')
-      FileUtils.touch('lib/main.rb')
+      FileUtils.touch('src/main.rb')
 
       File.open('Gemfile', "w") do |g_file|
         g_file.puts 'source "https://rubygems.org"'
       end
 
-      File.open('lib/main.rb', "w") do |m_file|
+      File.open('src/main.rb', "w") do |m_file|
         m_file.puts 'puts "Hello, world"'
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbforge
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - mvghasty