v/pingme
1
0
Fork 0
mirror of https://github.com/kha7iq/pingme.git synced 2025-05-15 22:30:11 -07:00
Code Issues Projects Releases Wiki Activity

docs: add minor fixes

Browse Source
This commit is contained in:
kha7iq 2021-04-29 23:27:01 +08:00
parent d9f690f2eb
commit 9b5027207d
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -4,19 +4,20 @@ possible.
## Project structure ## Project structure
- `main` - Contains definitions for the underlying notification services. - `service` - Contains definitions for the underlying notification services.
- `cmd/discord` - Discord notification service. - `service/discord` - Discord notification service.
- `cmd/email` - Email notification service. - `service/email` - Email notification service.
- `cmd/msteams` - Microsoft Teams notification service. - `service/msteams` - Microsoft Teams notification service.
- `cmd/rocketchat` - RocketChat notification service. - `service/rocketchat` - RocketChat notification service.
- `cmd/slack` - Slack notification service. - `service/slack` - Slack notification service.
- `cmd/telegram` - Telegram notification service - `service/telegram` - Telegram notification service.
- `service/pushover` - Pushover Notification service.
- Documentation - Documentation
`docs` - Contains the documentation in markdown format. `docs` - Contains the documentation in Markdown format.
- `services.md` If you are adding a new service please add documentaiton to `services.md`. - `services.md` If you are adding a new service please add documentation to `services.md`.
- `home.md` Is the main page rendered when docs website is loaded. - `home.md` Is the main page rendered when docs website is loaded.
- `install.md` Contains the install instructions for different packages. - `install.md` Contains the installation instructions for different packages.
- Checking Locally - Checking Locally
- Docsify is used for documentation rendering from markdown, you can download - Docsify is used for documentation rendering from markdown, you can download