mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 05:23:03 +12:00
docs: clarify example in readme
This commit is contained in:
parent
2efcf12818
commit
c29c8ab7f6
2 changed files with 10 additions and 6 deletions
7
.github/PULL_REQUEST_TEMPLATE.md
vendored
7
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,9 +1,4 @@
|
|||
### Contributor checklist
|
||||
# Contributor checklist
|
||||
|
||||
- [ ] My commit messages follow the [Conventional Commit Message Format](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
|
||||
For example: `fix: Multiply by appropriate coefficient`, or
|
||||
`feat(Calculator): Correctly preserve history`
|
||||
Any explanation or long form information in your commit message should be
|
||||
in a separate paragraph, separated by a blank line from the primary message
|
||||
- [ ] Bug fixes include regression tests
|
||||
- [ ] Features include unit/acceptance tests
|
||||
|
|
|
@ -8,6 +8,15 @@ For information on creating a new Elixir application, see [this guide](https://e
|
|||
|
||||
Add `ash` to your dependencies in `mix.exs`. The latest version can be found by running `mix hex.info ash`.
|
||||
|
||||
```elixir
|
||||
# in mix.exs
|
||||
def deps() do
|
||||
[
|
||||
{:ash, "~> x.x.x"}
|
||||
]
|
||||
end
|
||||
```
|
||||
|
||||
## Create an Ash API
|
||||
|
||||
Create an API module. This will be your primary way to interact with your Ash resources. We recommend `lib/my_app/api.ex` for simple setups. For more information on organizing resources into contexts/domains, see the "Contexts and Domains" guide.
|
||||
|
|
Loading…
Reference in a new issue