From 56b2cbc10494067680a81e3209195c229f99b5e6 Mon Sep 17 00:00:00 2001
From: Dominic Ricottone <me@dominic-ricottone.com>
Date: Sun, 7 Apr 2024 14:30:27 -0500
Subject: [PATCH] Adding docs

---
 LICENSE.md | 31 +++++++++++++++++++++++++++++++
 README.md  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 65 insertions(+)
 create mode 100644 LICENSE.md
 create mode 100644 README.md

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..01e2fb3
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,31 @@
+BSD 3-Clause License
+====================
+
+_Copyright (c) 2024, Dominic Ricottone_  
+_All rights reserved._
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..401d85f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# nspotify
+
+Minimal TUI spotify client.
+Read-only interface to a user's saved songs.
+Playback sold separately,
+see [spotifyd](https://github.com/Spotifyd/spotifyd) or
+[go-librespot](https://github.com/devgianlu/go-librespot).
+
+
+## Building
+
+Depends on a small set of libraries:
+
+ + [zmb3's spotify API wrapper](github.com/zmb3/spotify)
+ + [logrus](github.com/sirupsen/logrus) for logging
+ + [tview](github.com/rivo/tview) and [tcell](https://github.com/gdamore/tcell)
+   for the TUI
+ + external `oauth2` package
+
+A Spotify API client ID and secret are required.
+See [here](https://github.com/zmb3/spotify?tab=readme-ov-file#authentication)
+for more details.
+Then try:
+
+```
+go build -ldflags "-X main.CLIENTID=yourclientid -X main.CLIENTSECRET=yourclientsecret" .
+```
+
+
+## Licensing
+
+I share the contents of this repository under the BSD 3 clause license.
+
+
-- 
2.45.2