Skip to content

Commit 2db3056

Browse files
committed
update readme
1 parent 7f36cb0 commit 2db3056

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

‎CLAUDE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
- Run framework specs: `bundle exec rspec spec`
77
- Build the gem: `bundle exec rake build`
88

9+
## Releases
10+
- Publish releases to [RubyGems](https://rubygems.org/gems/mk_framework), not GitHub Releases. Do not create GitHub Releases; Git tags can still mark versions.
11+
- Run the framework tests and build the gem before publishing it with `gem push pkg/mk_framework-VERSION.gem` (replace `VERSION` with the release version).
12+
- After publishing, verify the version on RubyGems and update the latest release version and its RubyGems link at the top of `README.md`. Keep the README installation examples and gem filename in sync with the published version.
13+
914
## Design and style
1015
- Include `# frozen_string_literal: true` in Ruby files.
1116
- Generate bracketed symbol arrays such as `[:id, :title]`, not `%i[id title]`.

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MK Framework
22

3+
Latest release: [0.2.5 on RubyGems](https://rubygems.org/gems/mk_framework/versions/0.2.5).
4+
35
Opinionated blazing fast Ruby API framework for creating JSON APIs with optional SQL (e.g. sqlite) backend.
46

57
Powered by [Roda](https://roda.jeremyevans.net/), and [Sequel](https://sequel.jeremyevans.net/)

0 commit comments

Comments
 (0)