https://github.com/andrewmcodes/andrewmcodes_gem
My gem card
https://github.com/andrewmcodes/andrewmcodes_gem
Last synced: 8 months ago
JSON representation
My gem card
- Host: GitHub
- URL: https://github.com/andrewmcodes/andrewmcodes_gem
- Owner: andrewmcodes
- License: mit
- Created: 2019-01-11T07:41:11.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-03-30T02:44:13.000Z (about 3 years ago)
- Last Synced: 2025-09-18T08:56:00.018Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 36.1 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# `andrewmcodes` Business Card
One of the first gems I ever released now updated for 2023. Whether I get fancy or stay simple, it's only job is to echo my info into the terminal.
[](https://www.repostatus.org/#active)
[](https://rubygems.org/gems/standard)
[](https://github.com/testdouble/standard)
[](https://conventionalcommits.org/)
[](https://choosealicense.com/licenses/mit/)
[](https://github.com/andrewmcodes/andrewmcodes_gem/actions/workflows/lint.yml)
[](https://github.com/andrewmcodes/andrewmcodes_gem/actions/workflows/test.yml)
[](https://github.com/andrewmcodes/andrewmcodes_gem/actions/workflows/publish.yml)
Nothing fancy, which is one of my goals with picking this project back up. **No perfectionism here! ✨**
## Installation
There is 0 reason to install this anywhere but your local machine, and even that now is unecessary! 🎉
Now that [rubygems/rubygems#6309](https://github.com/rubygems/rubygems/pull/6309) has merged, you no longer have to install this gem to use it. Similarly to `npx`, you can run `gem exec andrewmcodes` and hopefully it will work. 🤞
## Usage
Recommended usage is to run the following command:
```shell
gem exec andrewmcodes
```
On older versions of RubyGems, you can run the following command:
```shell
gem install andrewmcodes
andrewmcodes
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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).
I have automated releases set up with GitHub Actions, so I skip the `rake release` steps. To set up your own automated release workflow, check out [this tutorial I wrote on how I do it!](https://andrewm.codes/blog/automating-ruby-gem-releases-with-github-actions/)
## Contributing
Contributions are always welcome, but this is my personal playground so I may want to solve the issue my own way or not at all. If anything, I'd encourage you to fork this and build your own!
Bug reports and pull requests are accepted on GitHub at https://github.com/andrewmcodes/andrewmcodes_gem. 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/andrewmcodes/andrewmcodes_gem/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in my project's codebases, issue trackers, chat rooms and mailing lists are expected to follow the [code of conduct](https://github.com/andrewmcodes/andrewmcodes_gem/blob/main/CODE_OF_CONDUCT.md).