Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/calebhearth/mentionable
https://github.com/calebhearth/mentionable
now
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/calebhearth/mentionable
- Owner: calebhearth
- License: other
- Created: 2020-05-01T20:34:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-13T21:38:15.000Z (about 1 year ago)
- Last Synced: 2024-04-15T14:20:02.536Z (9 months ago)
- Topics: now
- Language: Ruby
- Homepage:
- Size: 76.2 KB
- Stars: 35
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Mentionable
An implementation of [Webmention], a web standard for mentions and conversyions
across the web. With mentionable, people can reply by sending webmentions for:
[Webmention]: "Webmention W3C Recommendation"
- commenting
- liking
- reposting
- mentioning / linking to
- quote
The `h-entry` specification provides for more types of reply, but these are what
Mentionable currently supports.
Mentionable sets up an endpoint in your Rails app to receive these Webmentions,
confirms that the reply actually links back to a page you've published, and
stores replies in the database for you to display or use as you please.
Optionally, Mentionable can be configured to send Webmentions when content you
create links to external sites. It does this by querying the link, performing
[Webmention endpoint discovery], and notifying sites that are set up to receive
Webmentions.
[Webmention endpoint discovery]:
You can configure one or more objects to be queried upon creation by telling
Mentionable what they are and what method to check for links.
## Usage
How to use my plugin.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'hearthside-mentionable', require: 'mentionable'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install hearthside-mentionable
```
## Contributing
Contribution directions go here.
## License
See LICENSE.md