chore: Update package links and docs.
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
James Harton 2024-03-06 20:24:29 +13:00
parent 2704eb27c5
commit f2664f6f99
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 34 additions and 9 deletions

View file

@ -1,6 +1,6 @@
# LexLuthor
[![Build Status](https://drone.harton.nz/api/badges/james/lex_luthor/status.svg)](https://drone.harton.nz/james/lex_luthor)
[![Build Status](https://drone.harton.dev/api/badges/james/lex_luthor/status.svg)](https://drone.harton.dev/james/lex_luthor)
LexLuthor is a Lexer in Elixir (say that 10 times fast) which uses macros to generate a reusable lexers. Good times.
@ -30,10 +30,26 @@ If lexing succeeds then you will receive an `:ok` tuple with the second value be
If lexing fails then you will receive an `:error` tuple which a reason and position.
## Contributing
## Installation
1. Fork it ( https://harton.dev/james/lex_luthor/fork )
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
LexLuthor is [available in Hex](https://hex.pm/packages/lex_luthor), the package
can be installed by adding `lex_luthor` to your list of dependencies in
`mix.exs`:
```elixir
def deps do
[
{:lex_luthor, "~> 0.1.2"}
]
end
```
Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/lex_luthor) and for the `main` branch on
[docs.harton.nz](https://docs.harton.nz/james/lex_luthor).
## Github Mirror
This repository is mirrored [on Github](https://github.com/jimsynz/lex_luthor)
from it's primary location [on my Forejo instance](https://harton.dev/james/lex_luthor).
Feel free to raise issues and open PRs on Github.

13
mix.exs
View file

@ -14,9 +14,18 @@ defmodule LexLuthor.Mixfile do
package: [
maintainers: ["James Harton <james@harton.nz>"],
licenses: ["MIT"],
links: %{"Source" => "https://harton.dev/james/lex_luthor"}
links: %{
"Source" => "https://harton.dev/james/lex_luthor",
"GitHub" => "https://github.com/jimsynz/lex_luthor",
"Changelog" => "https://docs.harton.nz/james/lex_luthor/changelog.html",
"Sponsor" => "https://github.com/sponsors/jimsynz"
}
],
deps: deps()
deps: deps(),
docs: [
main: "readme",
extras: ["README.md", "CHANGELOG.md"]
]
]
end