Skip to content

Commit dc288f0

Browse files
committed
Populate README.md partially
1 parent cc49fdb commit dc288f0

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Urlpattern
1+
# urlpattern
22

3-
TODO: Delete this and the text below, and describe your gem
3+
An implementation of [the URL Pattern Standard](https://urlpattern.spec.whatwg.org/) for Ruby written in Rust.
44

5-
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/urlpattern`. To experiment with that code, run `bin/console` for an interactive prompt.
5+
## Description
6+
7+
It's a thin wrapper of [denoland/rust-urlpattern](https://github.com/denoland/rust-urlpattern) with [Magnus](https://github.com/matsadler/magnus).
8+
9+
It is useful on the server side when serving different pages based on the URL (a.k.a. routing). It provides pattern matching syntax like `/users/:id`, similar to [route parameters in Express](https://expressjs.com/en/guide/routing.html#route-parameters) or [Path-to-RegExp](https://github.com/pillarjs/path-to-regexp). You can use it as a foundation to build your own web server or framework.
610

711
## Installation
812

@@ -32,12 +36,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
3236

3337
## Contributing
3438

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/urlpattern. 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/[USERNAME]/urlpattern/blob/main/CODE_OF_CONDUCT.md).
39+
Bug reports and pull requests are welcome on GitHub at https://github.com/urlpattern/ruby-urlpattern. 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/urlpattern/ruby-urlpattern/blob/main/CODE_OF_CONDUCT.md).
3640

3741
## License
3842

3943
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
4044

4145
## Code of Conduct
4246

43-
Everyone interacting in the Urlpattern project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/urlpattern/blob/main/CODE_OF_CONDUCT.md).
47+
Everyone interacting in the Urlpattern project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/urlpattern/ruby-urlpattern/blob/main/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)