You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
6
4
7
5
## Installation
8
6
9
-
Add this line to your application's Gemfile:
7
+
Add this line to your application's Gemfile development group:
10
8
11
9
```ruby
12
-
gem 'boxing'
10
+
group :developmentdo
11
+
gem 'boxing'
12
+
end
13
13
```
14
14
15
15
And then execute:
16
16
17
17
$ bundle install
18
18
19
-
Or install it yourself as:
19
+
## Usage
20
20
21
-
$ gem install boxing
21
+
### Generate
22
22
23
-
## Usage
23
+
To generate `Dockerfile` for current project
24
+
25
+
```ruby
26
+
bundle exec boxing generate
27
+
```
24
28
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
26
46
27
47
## Development
28
48
@@ -32,8 +52,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
32
52
33
53
## Contributing
34
54
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).
36
56
37
57
## Code of Conduct
38
58
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