mirror of
https://github.com/ash-project/ash_double_entry.git
synced 2024-09-17 03:53:17 +12:00
docs: documentation overhaul
This commit is contained in:
parent
4e0195726b
commit
f520c1ac04
3 changed files with 24 additions and 18 deletions
31
README.md
31
README.md
|
@ -1,22 +1,21 @@
|
||||||
|
![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_double_entry/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_double_entry.svg)](https://hex.pm/packages/ash_double_entry)
|
||||||
|
[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_double_entry)
|
||||||
|
|
||||||
# AshDoubleEntry
|
# AshDoubleEntry
|
||||||
|
|
||||||
An extensible double entry system built using [Ash](ash-hq.org) resources.
|
Welcome! This is the extension for building a double entry accounting system in [Ash](https://hexdocs.pm/ash). This extension provides the basic building blocks for you to extend as necessary.
|
||||||
|
|
||||||
See the [getting started guide](https://hexdocs.pm/ash_double_entry/get-started-with-double-entry.html) to
|
## Tutorials
|
||||||
setup the project!
|
|
||||||
|
|
||||||
## Installation
|
- [Getting Started with AshDoubleEntry](documentation/tutorials/getting-started-with-ash-double-entry.md)
|
||||||
|
|
||||||
The package can be installed by adding `ash_double_entry` to your list of dependencies in `mix.exs`:
|
## Reference
|
||||||
|
|
||||||
```elixir
|
- [AshDoubleEntry.Account DSL](documentation/dsls/DSL:-AshDoubleEntry.Account.md)
|
||||||
def deps do
|
- [AshDoubleEntry.Transfer DSL](documentation/dsls/DSL:-AshDoubleEntry.Transfer.md)
|
||||||
[
|
- [AshDoubleEntry.Balance DSL](documentation/dsls/DSL:-AshDoubleEntry.Balance.md)
|
||||||
{:ash_double_entry, "~> 1.0.0-rc.1"}
|
|
||||||
]
|
|
||||||
end
|
|
||||||
```
|
|
||||||
|
|
||||||
# Upgrading from 0.1 to 0.2
|
|
||||||
|
|
||||||
This is a breaking change, that changes from using a currency & decimal amount to using `ash_money`. There is no way to configure it to use the old behavior, as maintaining both is not reasonable.
|
|
||||||
|
|
|
@ -14,6 +14,12 @@ Ash Double Entry is implemented as a set of Ash resource extensions. You build t
|
||||||
|
|
||||||
Follow the setup guide for `AshMoney`. If you are using with `AshPostgres`, be sure to include the `:ex_money_sql` dependency in your `mix.exs`.
|
Follow the setup guide for `AshMoney`. If you are using with `AshPostgres`, be sure to include the `:ex_money_sql` dependency in your `mix.exs`.
|
||||||
|
|
||||||
|
### Add the dependency
|
||||||
|
|
||||||
|
```elixir
|
||||||
|
{:ash_double_entry, "~> 1.0.0-rc.0"}
|
||||||
|
```
|
||||||
|
|
||||||
### Define your account resource
|
### Define your account resource
|
||||||
|
|
||||||
#### Example
|
#### Example
|
5
mix.exs
5
mix.exs
|
@ -64,7 +64,7 @@ defmodule AshDoubleEntry.MixProject do
|
||||||
|
|
||||||
defp docs do
|
defp docs do
|
||||||
[
|
[
|
||||||
main: "get-started-with-double-entry",
|
main: "readme",
|
||||||
source_ref: "v#{@version}",
|
source_ref: "v#{@version}",
|
||||||
logo: "logos/small-logo.png",
|
logo: "logos/small-logo.png",
|
||||||
before_closing_head_tag: fn type ->
|
before_closing_head_tag: fn type ->
|
||||||
|
@ -83,7 +83,8 @@ defmodule AshDoubleEntry.MixProject do
|
||||||
end
|
end
|
||||||
end,
|
end,
|
||||||
extras: [
|
extras: [
|
||||||
"documentation/tutorials/get-started-with-double-entry.md",
|
{"README.md", title: "Home"},
|
||||||
|
"documentation/tutorials/getting-started-with-ash-double-entry.md",
|
||||||
"documentation/dsls/DSL:-AshDoubleEntry.Account.md",
|
"documentation/dsls/DSL:-AshDoubleEntry.Account.md",
|
||||||
"documentation/dsls/DSL:-AshDoubleEntry.Balance.md",
|
"documentation/dsls/DSL:-AshDoubleEntry.Balance.md",
|
||||||
"documentation/dsls/DSL:-AshDoubleEntry.Transfer.md"
|
"documentation/dsls/DSL:-AshDoubleEntry.Transfer.md"
|
||||||
|
|
Loading…
Reference in a new issue