From 97da27294d2b194b8e481fcc9b2e5bbfe8e338c0 Mon Sep 17 00:00:00 2001
From: Timothy Warren <twarren@nabancard.com>
Date: Fri, 29 Mar 2019 10:35:58 -0400
Subject: [PATCH] Add README, LICENSE, and Makefile

---
 Cargo.lock |  2 +-
 Cargo.toml |  9 +++++++--
 LICENSE.md |  7 +++++++
 Makefile   | 42 ++++++++++++++++++++++++++++++++++++++++++
 README.md  | 14 ++++++++++++++
 5 files changed, 71 insertions(+), 3 deletions(-)
 create mode 100644 LICENSE.md
 create mode 100644 Makefile
 create mode 100644 README.md

diff --git a/Cargo.lock b/Cargo.lock
index 01b644b..d687376 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -495,7 +495,7 @@ version = "0.1.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
-name = "media_collection_crud"
+name = "media-collection-crud"
 version = "0.1.0"
 dependencies = [
  "bodyparser 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
diff --git a/Cargo.toml b/Cargo.toml
index cfc8f95..4ef15f2 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,8 +1,11 @@
 [package]
-name = "media_collection_crud"
+name = "media-collection-crud"
+license = "MIT"
+description = "Expiremental CRUD for managing a personal collection of media"
 version = "0.1.0"
 authors = ["Timothy J Warren <tim@timshomepage.net>"]
 edition = "2018"
+publish = false
 
 [dependencies]
 bodyparser = "0.8.0"
@@ -12,7 +15,6 @@ env_logger = "0.6.1"
 handlebars = "1.1.0"
 handlebars-iron = { version = "0.27.0", features = ["watch"] }
 iron = "0.6.0"
-iron-test = "0.6.0"
 juniper = "0.11.1"
 logger = "0.4.0"
 mime = "0.2.3"
@@ -22,3 +24,6 @@ serde = "1.0.89"
 serde_json = "1.0.39"
 staticfile = "0.5.0"
 urlencoded = "0.6.0"
+
+[dev-dependencies]
+iron-test = "0.6.0"
\ No newline at end of file
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..81877e4
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,7 @@
+Copyright (c) 2019, Timothy J. Warren 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..5eede15
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,42 @@
+# The default make command
+DEFAULT = help
+
+# Use 'VERBOSE=1' to echo all commands, for example 'make help VERBOSE=1'.
+ifdef VERBOSE
+  Q :=
+else
+  Q := @
+endif
+
+
+all: $(DEFAULT)
+
+help:
+	$(Q)echo "make run               - Runs executable"
+	$(Q)echo "make build             - Builds main executable"
+	$(Q)echo "make lib               - Builds library"
+	$(Q)echo "make test              - Runs all tests"
+	$(Q)echo "make bench             - Benchmarks library internally and externally"
+	$(Q)echo "make bench-internal    - Benchmarks library internally"
+	$(Q)echo "make bench-external    - Benchmarks library externally"
+	$(Q)echo "make doc               - Builds documentation for library"
+	$(Q)echo "make git-ignore        - Setup files to be ignored by Git"
+	$(Q)echo "make examples          - Builds examples"
+	$(Q)echo "make clean             - Deletes binaries and documentation.
+
+.PHONY: build run test bench doc examples clean
+
+build:
+	$(CARGO) build
+
+run:
+	$(CARGO) run
+
+clean:
+	$(CARGO) clean
+
+doc:
+	$(CARGO) doc
+
+test:
+	$(CARGO) test
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c5c681c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Media Collection CRUD
+
+This is an experiment with using Rust to build a CRUD web app.
+
+## Project Goals
+
+* Create a practical "web app" to view / manage a collection of media, eg Movies, Video Games, Music.
+* Strike a balance in Database design between a completely generic design, and a medium-specific design
+* Utilize Rust as the primary implementation language
+* Utilize Graphviz for design diagrams
+
+## Non-Goals
+* Single-Page App
+* Full interface / Web API separation
\ No newline at end of file