streaming

commit d80d8e86bfabae829e62cce890148ad795743e3a
parent 25eae1eaba327961f34375c0d948debc21e1f021
Author: Oliver Lowe <o@olowe.co>
Date:   Wed,  1 May 2024 14:39:48 +1000

Include pics, contributing, licensing in README

Diffstat:
D
README
 | 
1
-
A
README.md
 | 
26
++++++++++++++++++++++++++

2 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/README b/README
@@ -1 +0,0 @@
-This repository contains packages for developing media streaming systems in Go.
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+This repository contains packages for developing media streaming systems in Go.
+
+[![pkgsite](https://pkg.go.dev/badge/github.com/untangledco/streaming)](https://pkg.go.dev/github.com/untangledco/streaming)
+
+## Contributing
+
+Patches are accepted via [pull requests](https://github.com/untangledco/streaming/pulls).
+
+Alternatively, patches are accepted via email.
+Post them to the mailing list
+[~otl/public-inbox@lists.sr.ht](mailto:~otl/public-inbox@lists.sr.ht),
+or to [Oliver Lowe](mailto:o@olowe.co).
+
+### Commit messages
+
+Commit messages follow the same format used by the [Go] project (among others).
+The commit subject starts with the affected package name then a brief description of the change.
+The body may contain an explanation of the change and why it was made.
+
+[Go]: https://go.dev/doc/contribute#commit_messages
+
+## License
+
+Unless otherwise noted, this sotfware is licensed under the ISC License.
+See LICENSE.
+\ No newline at end of file