mirror of
https://github.com/danbee/micropub.git
synced 2025-03-04 08:59:13 +00:00
It's not a gem
This commit is contained in:
parent
9fc7297134
commit
c9f56fcc36
42
README.md
42
README.md
@ -1,43 +1,21 @@
|
|||||||
# Micropub
|
# Micropub
|
||||||
|
|
||||||
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/micropub`. To experiment with that code, run `bin/console` for an interactive prompt.
|
A micropub endpoint for my Hugo based blog.
|
||||||
|
|
||||||
TODO: Delete this and the text above, and describe your gem
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Add this line to your application's Gemfile:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
gem 'micropub'
|
|
||||||
```
|
|
||||||
|
|
||||||
And then execute:
|
|
||||||
|
|
||||||
$ bundle
|
|
||||||
|
|
||||||
Or install it yourself as:
|
|
||||||
|
|
||||||
$ gem install micropub
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
TODO: Write usage instructions here
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/micropub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
Bug reports and pull requests are welcome on GitHub at
|
||||||
|
https://github.com/danbee/micropub. This project is intended to be a safe,
|
||||||
|
welcoming space for collaboration, and contributors are expected to adhere to
|
||||||
|
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
The project is available as open source under the terms of the [MIT
|
||||||
|
License](https://opensource.org/licenses/MIT).
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
Everyone interacting in the Micropub project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/micropub/blob/master/CODE_OF_CONDUCT.md).
|
Everyone interacting in the Micropub project’s codebases, issue trackers, chat
|
||||||
|
rooms and mailing lists is expected to follow the [code of
|
||||||
|
conduct](https://github.com/[USERNAME]/micropub/blob/master/CODE_OF_CONDUCT.md).
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user