Skip to content

Commit

Permalink
docs: 📝 Improve doc for Docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
5ika committed Aug 11, 2023
1 parent a13d808 commit 9ed0fb8
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,21 @@ It's Free, Open-Source and self-hostable.
- [Demo project using Fidbee](./demo/)
- [Server example for webhooks](./server-example/)

## Getting started

See doc in [Fidbee React component](./lib/) directory.

## Demo

A Docker image is available on Docker Hub for a quick demo:

```bash
docker run -it --rm -p 8080:8080 --name fidbee octree/fidbee-demo
```

Then go to http://localhost:8080.
Server's logs on new notifications are displayed in the container's logs.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
Expand All @@ -20,4 +35,4 @@ See also the list of [contributors](https://github.com/octree-gva/fidbee/graphs/

## License

This project is licensed under the AGPL v3 License - see the [LICENSE.md](LICENSE.md) file for details
This project is licensed under the AGPL v3 License - see the [LICENSE.md](LICENSE.md) file for details

0 comments on commit 9ed0fb8

Please sign in to comment.