add README and update module name
This commit is contained in:
parent
3b4dc324eb
commit
020b4baba8
2 changed files with 46 additions and 1 deletions
45
README.md
Normal file
45
README.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
# pnut-bridge
|
||||
|
||||
A [matterbridge] API plugin allowing you to connect message channels on pnut.io to other supported chat services.
|
||||
|
||||
## Contributing
|
||||
|
||||
Report bugs or submit pull requests on [codeberg] or via email.
|
||||
|
||||
Join my public chat room for development discussion.
|
||||
|
||||
- [#dev:thrrgilag.ems.host]
|
||||
- [xmpp:dev@groups.clacks.network]
|
||||
- [#thrrgilag on Libera.Chat]
|
||||
|
||||
## License
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021 Morgan McMillian
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
[codeberg]: https://codeberg.org/thrrgilag/pnut-bridge
|
||||
[#dev:thrrgilag.ems.host]: https://matrix.to/#/#dev:thrrgilag.ems.host
|
||||
[xmpp:dev@groups.clacks.network]: xmpp:dev@groups.clacks.network?join
|
||||
[#thrrgilag on Libera.Chat]: ircs://irc.libera.chat/#thrrgilag
|
||||
|
2
go.mod
2
go.mod
|
@ -1,4 +1,4 @@
|
|||
module git.sr.ht/~thrrgilag/pnut-bridge
|
||||
module mcmillian.dev/go/pnut-bridge
|
||||
|
||||
go 1.16
|
||||
|
||||
|
|
Loading…
Reference in a new issue