Skip to content

Commit

Permalink
Cleanup README, prepare for v0.1.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
linjunpop committed Aug 19, 2021
1 parent 7bee731 commit d4dc104
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
The package can be installed
by adding `app_store` to your list of dependencies in `mix.exs`:

```elixir
Expand All @@ -15,10 +15,6 @@ def deps do
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/app_store](https://hexdocs.pm/app_store).

## Usage

Add the default HTTP client `AppStore.HTTPClient.DefaultClient` to the application's supervision tree:
Expand Down Expand Up @@ -46,3 +42,5 @@ app_store =
```

Now you can use functions in `AppStore.API` module to interact with the App Store Server APIs.

Please check [https://hexdocs.pm/app_store](https://hexdocs.pm/app_store) for a full documentation.

0 comments on commit d4dc104

Please sign in to comment.