-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added instructions to run Flame example app
- Loading branch information
Showing
2 changed files
with
10 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,9 @@ | ||
# FlameExample | ||
# Flame Example | ||
|
||
**TODO: Add description** | ||
Example of a Flame application using the flame_k8s backend based on the Operator Pattern. | ||
|
||
## Installation | ||
## Installation and Run | ||
|
||
If [available in Hex](https://hex.pm/docs/publish), the package can be installed | ||
by adding `flame_example` to your list of dependencies in `mix.exs`: | ||
|
||
```elixir | ||
def deps do | ||
[ | ||
{:flame_example, "~> 0.1.0"} | ||
] | ||
end | ||
```sh | ||
$ make all | ||
``` | ||
|
||
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/flame_example>. | ||
|