Skip to content

Commit ab4e6f5

Browse files
committed
Added a bit of info to the README; not done.
1 parent dd9a0fe commit ab4e6f5

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# overview
1+
# Overview
22

3-
hello, world
3+
`cplayer` is a small, statically served album-based audio player for modern web browsers. You simply drop a build into a directory on your web server, create a `manifest.json` file that describes the album metadata and track URIs and you're done.
4+
5+
It looks something like this:
6+
7+
![cplayer screenshot](/doc/img/screenshot.png)
8+
9+
# Why?
10+
11+
I had the need to share some music I recorded with a couple other people, and didn't want to bother creating a SoundCloud account, uploading them to YouTube, or sending them via email. I just wanted to host my own music and provide a simple, lightweight web-based player for others to use to listen to the audio.
12+
13+
# Usage
14+
15+
TODO

doc/img/screenshot.png

39.7 KB
Loading

0 commit comments

Comments
 (0)