mirror of
https://github.com/ash-project/ash_money.git
synced 2024-09-19 12:53:11 +12:00
docs: docs overhaul
This commit is contained in:
parent
097ff39938
commit
4752d7e533
3 changed files with 21 additions and 8 deletions
18
README.md
18
README.md
|
@ -1,3 +1,19 @@
|
||||||
|
![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-black-text.png?raw=true#gh-light-mode-only)
|
||||||
|
![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-white-text.png?raw=true#gh-dark-mode-only)
|
||||||
|
|
||||||
|
![Elixir CI](https://github.com/ash-project/ash_money/workflows/CI/badge.svg)
|
||||||
|
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
||||||
|
[![Hex version badge](https://img.shields.io/hexpm/v/ash_money.svg)](https://hex.pm/packages/ash_money)
|
||||||
|
[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_money)
|
||||||
|
|
||||||
# AshMoney
|
# AshMoney
|
||||||
|
|
||||||
A money extension for Ash.
|
Welcome! This is the extension for working with money types in [Ash](https://hexdocs.pm/ash). This is a thin wrapper around the very excellent [ex_money](https://hexdocs.pm/ex_money). It provides:
|
||||||
|
|
||||||
|
- An `Ash.Type` for representing `Money`
|
||||||
|
- An `AshPostgres.Extension` for supporting common money operations directly in the database
|
||||||
|
- An implementation of `Comp` for `%Money{}`, allowing Ash to compare them.
|
||||||
|
|
||||||
|
## Tutorials
|
||||||
|
|
||||||
|
- [Getting Started with AshMoney](documentation/tutorials/getting-started-with-ash-money.md)
|
||||||
|
|
11
mix.exs
11
mix.exs
|
@ -4,7 +4,7 @@ defmodule AshMoney.MixProject do
|
||||||
@version "0.1.6-rc.1"
|
@version "0.1.6-rc.1"
|
||||||
|
|
||||||
@description """
|
@description """
|
||||||
A money extension for Ash.
|
The extension for working with money types in Ash.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def project do
|
def project do
|
||||||
|
@ -18,10 +18,6 @@ defmodule AshMoney.MixProject do
|
||||||
package: package(),
|
package: package(),
|
||||||
elixirc_paths: elixirc_paths(Mix.env()),
|
elixirc_paths: elixirc_paths(Mix.env()),
|
||||||
dialyzer: [plt_add_apps: [:ash]],
|
dialyzer: [plt_add_apps: [:ash]],
|
||||||
preferred_cli_env: [
|
|
||||||
coveralls: :test,
|
|
||||||
"coveralls.github": :test
|
|
||||||
],
|
|
||||||
docs: docs(),
|
docs: docs(),
|
||||||
description: @description,
|
description: @description,
|
||||||
source_url: "https://github.com/ash-project/ash_money",
|
source_url: "https://github.com/ash-project/ash_money",
|
||||||
|
@ -58,7 +54,7 @@ defmodule AshMoney.MixProject do
|
||||||
|
|
||||||
defp docs do
|
defp docs do
|
||||||
[
|
[
|
||||||
main: "get-started-with-ash-money",
|
main: "readme",
|
||||||
source_ref: "v#{@version}",
|
source_ref: "v#{@version}",
|
||||||
logo: "logos/small-logo.png",
|
logo: "logos/small-logo.png",
|
||||||
extra_section: "GUIDES",
|
extra_section: "GUIDES",
|
||||||
|
@ -78,7 +74,8 @@ defmodule AshMoney.MixProject do
|
||||||
end
|
end
|
||||||
end,
|
end,
|
||||||
extras: [
|
extras: [
|
||||||
"documentation/tutorials/get-started-with-ash-money.md"
|
{"README.md", title: "Home"},
|
||||||
|
"documentation/tutorials/getting-started-with-ash-money.md"
|
||||||
],
|
],
|
||||||
groups_for_extras: [
|
groups_for_extras: [
|
||||||
Tutorials: ~r'documentation/tutorials',
|
Tutorials: ~r'documentation/tutorials',
|
||||||
|
|
Loading…
Reference in a new issue