README file

.idea/deployment.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PublishConfigData" persistUploadOnCheckin="false" />
+</project>

README.md

@@ -0,0 +1,38 @@
+
+# Undefined
+
+A self-hosted music streaming service, with a client written in JavaFX for a graded CS project.
+
+## Features
+
+* Host your music on you own [server](https://github.com/ambrosechua/Undefined-server).
+* Stream via HTTP from anywhere around the world.
+* Albums, Artists, Songs.
+* Easy to use nw.js server interface.
+
+## Future features
+
+* Offline playback
+* Improved UX
+* Playlisting
+
+## Usage
+
+### Get server
+
+#### Option 1: Devs
+
+1. Get [node.js](http://nodejs.org)
+2. `git clone https://github.com/ambrosechua/Undefined-server.git`
+3. `cd Undefined-server`
+4. `npm install`
+5. `npm start`
+6. Dump music according to structure in Wiki.
+
+#### Option 2: Users
+
+[Download](https://github.com/ambrosechua/Undefined-server/releases) the nw.js application, unzip it, run it.
+
+### Get client
+
+Download a prepackaged jar in [releases](https://github.com/ambrosechua/Undefined/releases). Run and enjoy!