Franz.Germann/ascii-live
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve README

Browse source
This commit is contained in:
Hugo 2020-03-09 13:51:23 +11:00
parent f8dee1d712
commit 6c7126b783
No known key found for this signature in database
GPG key ID: D77F4AD765CA9D4F
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -11,6 +11,17 @@ curl ascii.live/parrot
<img src="./demo.gif" width="400"/> <img src="./demo.gif" width="400"/>
## Running locally
To run the server locally on port `8080`, run:
```bash
go run main.go
```
## Running in Docker
```bash
docker run -p 8080:8080 hugomd/ascii-live:latest
```
## Adding frames ## Adding frames
* [Fork this repository](https://github.com/hugomd/ascii-live/fork) * [Fork this repository](https://github.com/hugomd/ascii-live/fork)
* Create a new frame file in [`/frames`](./frames), call it the name of your frames/animation, e.g. `parrot.go` * Create a new frame file in [`/frames`](./frames), call it the name of your frames/animation, e.g. `parrot.go`