summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArjun Satarkar <me@arjunsatarkar.net>2024-11-02 19:31:45 +0000
committerArjun Satarkar <me@arjunsatarkar.net>2024-11-02 19:33:28 +0000
commit475286136da68c0a9cc8bec95d042f7243553fb4 (patch)
tree91b10c530308264f34dbede624cc52d4c73ce9b7 /README.md
parent0b403eb8212eea318a13a640ab1efad9490845e4 (diff)
downloadmediasync-475286136da68c0a9cc8bec95d042f7243553fb4.tar
mediasync-475286136da68c0a9cc8bec95d042f7243553fb4.tar.gz
mediasync-475286136da68c0a9cc8bec95d042f7243553fb4.zip
Add license, README, CI
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1b692a7..956548f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# mediasync
+# Mediasync
+
+Watch a video in sync with other people remotely. The host can pause, seek within the video, and so forth.
+
+The server is written in Elixir, and the frontend in JavaScript using [video.js](https://videojs.com/).
+
+## Copyright and License Notice
+
+Copyright (C) 2024-present Arjun Satarkar
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+### Note on Vendored Libraries
+
+Present in the source tree of this project are certain other open source projects used as dependencies, eg. [video.js](https://videojs.com/) and [Font Awesome](https://fontawesome.com/). The licenses applicable to those projects are present in the directories in which they are contained.