An open API service indexing awesome lists of open source software.

https://github.com/eniehack/webmention.cr

[mirror from GitLab] library to find Webmention endpoints from website for Crystal-lang
https://github.com/eniehack/webmention.cr

crystal shards webmention

Last synced: 8 months ago
JSON representation

[mirror from GitLab] library to find Webmention endpoints from website for Crystal-lang

Awesome Lists containing this project

README

          

# webmention-cr

[![Docs status](https://img.shields.io/badge/docs-available-brightgreen.svg?style=flat-square)](https://eniehack.gitlab.io/webmention.cr/)
![Gitlab pipeline status](https://img.shields.io/gitlab/pipeline/eniehack/webmention.cr/master?style=flat-square)

[WebMention](https://www.w3.org/TR/webmention) library for Crystal lang.

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
webmention:
gitlab: eniehack/webmention.cr
```

2. Run `shards install`

## Usage

```crystal
require "webmention"
require "http/client"
require "uri"

url = URI.parse "https://www.example.com"
response = HTTP::Client.get url
webmention = Webmention::Discover.new response, url
endpoint = webmention.discover
```

## Development

TODO: Write development instructions here

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [eniehack](https://gitlab.com/eniehack) - creator and maintainer