matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#117 part 1: New documentation website (#151)

Browse Source 
This commit concerns the first subtask of this issue: https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117

It provide a brand new documentation website, that replace the previous markdown files.
The website is auto-generated using CI/CD, and can be found here: https://johnxlivingston.github.io/peertube-plugin-livechat/
This commit is contained in:
John Livingston
2023-02-13 17:58:06 +01:00
committed by GitHub
parent dc1de61a95
commit e17257a90f
114 changed files with 2302 additions and 990 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,53 +1,13 @@
# PeerTube plugin livechat 🇬🇧
🇫🇷 French version / Version française [ici](README.fr.md).
🇩🇪 German version / deutsche Version [hier](./README.de.md).
🇯🇵 Japanese version / 日本語バージョン [こちら](./README.ja.md).
# PeerTube plugin livechat
This [Peertube](https://joinpeertube.org/) plugin is meant to provide chat system for Peertube videos.
![Chat screenshot](documentation/screenshots/chat.png)
To read the documentation, please refer to any of these:
![Fullscreen chat screenshot](documentation/screenshots/fullscreen.png)
See a [demo](https://www.yiny.org/w/399a8d13-d4cf-4ef2-b843-98530a8ccbae).
* 🇬🇧 [Plugin Livechat Documentation on Github](https://johnxlivingston.github.io/peertube-plugin-livechat/)
* 🇫🇷 [French version / Version française](https://johnxlivingston.github.io/peertube-plugin-livechat/fr/)
* 🇩🇪 [German version / deutsche Version](https://johnxlivingston.github.io/peertube-plugin-livechat/de/)
* 🇯🇵 [Japanese version / 日本語バージョン](https://johnxlivingston.github.io/peertube-plugin-livechat/ja/)
* [The documentation source code](./support/documentation/content/)
**Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](CHANGELOG.md)**.
## Documentation
* [Installation guide](documentation/installation.md)
* [User guide](documentation/user.md)
* [Administrator guide](documentation/admin.md)
## New features requests / Bug tracking
If you have new feature requests, bugs, or difficulties to setup the plugin, you can use the [Github issue tracker](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues).
Here is a roadmap for upcoming features: [ROADMAP](ROADMAP.md).
If you are a webdesigner or a ConverseJS/Prosody/XMPP expert, and want to help improve this plugin, you are welcome.
## Contact me
If you have any question, or if you want to talk about this plugin, you can join this XMPP room with any Jabber client: [plugin-livechat-support@room.im.yiny.org](xmpp:plugin-livechat-support@room.im.yiny.org?join).
If you want to support the project financially, you can contact me by mail at git.[at].john-livingston.fr, or check my [Liberapay profile](https://liberapay.com/JohnLivingston/).
## Contribute
Please refer to the page [CONTRIBUTING.md](CONTRIBUTING.md).
## Credits
[package.json](package.json), [COPYRIGHT](COPYRIGHT.md) and [LICENSE](LICENSE) files contain the license information for this software and its dependencies.
Thanks to David Revoy for his work on Peertube's mascot, [Sepia](https://www.davidrevoy.com/index.php?tag/peertube).
The character design is under CC-By licence, and the SVG files used to create some logo and avatars in this plugin are GPLv3.0.
Thanks to [Framasoft](https://framasoft.org) for making [Peertube](https://joinpeertube.org/) possible, and for the financial support.
Thanks to [ritimo](https://www.ritimo.org/) for the financial support.
Thanks to [Code Lutin](https://www.codelutin.com/) and [Rétribution Copie Publique](https://copiepublique.fr/) for the financial support.