Browse Source

Updating readme with development and build badges

pull/10/head
Drew Short 5 years ago
parent
commit
7cb47dbb2e
  1. 26
      README.md

26
README.md

@ -1,5 +1,8 @@
# Baphomet # Baphomet
Development Branch Tests [![Concourse](https://concourse.nulloctet.com/api/v1/teams/nulloctet/pipelines/baphomet-js/jobs/test-develop/badge)](https://concourse.nulloctet.com/teams/nulloctet/pipelines/baphomet-js)
Master Branch Tests [![Concourse](https://concourse.nulloctet.com/api/v1/teams/nulloctet/pipelines/baphomet-js/jobs/test/badge)](https://concourse.nulloctet.com/teams/nulloctet/pipelines/baphomet-js)
Baphomet is a bot to provide extended functionality to a matrix server Baphomet is a bot to provide extended functionality to a matrix server
## Configuration ## Configuration
@ -10,12 +13,31 @@ Copy data/config.json.example to data/config.json and replace the relevent confi
```bash ```bash
npm install npm install
node index.js
./entrypoint.sh run
``` ```
## Development ## Development
TBD
### Requirements:
Nodejs 12 LTS
OR
Docker
#### Local:
```bash
npm install
#<make changes>
./entrypoint.sh run
```
#### Docker:
```bash
./scripts/run_development_docker.sh
```
## Contributing ## Contributing

Loading…
Cancel
Save