Skip to content

Commit 472262e

Browse files
committed
Update README
1 parent 695f7a0 commit 472262e

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

README.md

+31-11
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
11
# Boxing
22

3-
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/boxing`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
3+
The zero-configuration Dockerfile generator for Ruby.
64

75
## Installation
86

9-
Add this line to your application's Gemfile:
7+
Add this line to your application's Gemfile development group:
108

119
```ruby
12-
gem 'boxing'
10+
group :development do
11+
gem 'boxing'
12+
end
1313
```
1414

1515
And then execute:
1616

1717
$ bundle install
1818

19-
Or install it yourself as:
19+
## Usage
2020

21-
$ gem install boxing
21+
### Generate
2222

23-
## Usage
23+
To generate `Dockerfile` for current project
24+
25+
```ruby
26+
bundle exec boxing generate
27+
```
2428

25-
TODO: Write usage instructions here
29+
## Roadmap
30+
31+
* [x] `Dockerfile` generator
32+
* [ ] Customize config file `config/boxing.rb`
33+
* [ ] Entrypoint Detection
34+
* [x] Openbox (Suggested)
35+
* [x] Ruby on Rails
36+
* [ ] Rack
37+
* [ ] Ruby
38+
* [ ] Package Database
39+
* [x] Built-in (Move to standalone repoistory in future)
40+
* [ ] Standalone Repoistory
41+
* [ ] Customize Source
42+
* [ ] Base Image
43+
* [x] Alpine
44+
* [ ] Ubuntu
45+
* [ ] Ruby Version
2646

2747
## Development
2848

@@ -32,8 +52,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
3252

3353
## Contributing
3454

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/boxing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/boxing/blob/main/CODE_OF_CONDUCT.md).
55+
Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/boxing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/elct9620/boxing/blob/main/CODE_OF_CONDUCT.md).
3656

3757
## Code of Conduct
3858

39-
Everyone interacting in the Boxing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/boxing/blob/main/CODE_OF_CONDUCT.md).
59+
Everyone interacting in the Boxing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elct9620/boxing/blob/main/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)