aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIndrajith K L2023-11-06 06:12:28 +0530
committerIndrajith K L2023-11-06 06:12:28 +0530
commitbf91c7ef4f374a78bff46a42a85c0426b0abf7d0 (patch)
treea38e002b64c3dd5fb6f9dca7791eba4f99a68760 /README.md
downloadwialt_listener-bf91c7ef4f374a78bff46a42a85c0426b0abf7d0.tar.gz
wialt_listener-bf91c7ef4f374a78bff46a42a85c0426b0abf7d0.tar.bz2
wialt_listener-bf91c7ef4f374a78bff46a42a85c0426b0abf7d0.zip
Initial CommitHEADmaster
* Listener Implementation - In-Progress * Initial API Endpoints and Websocket implementation * API End Points Implemented -> /music_changed, /state_change * Websocket End Points implemented -> /i_am_listening_to * Socket Implementation - In-Progress
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..abeadbc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# [W]hat [I] [A]m [L]istening [T]o Listener
+
+A Web Server written in Crystal Lang which is part of WIALT Project. This server is a broker server which act as a bridge between Local MPC Music Player and indrajith.dev website. Whose main purpose is to display music title I'am listening to.
+
+## Installation
+
+* Install Crystal
+* `shards install`
+
+## Usage
+
+* `crystal run src/wialt_listener.cr`
+
+## Contributors
+
+- [Indrajith K L](https://github.com/cooljith91112) - creator and maintainer