From c32fae261c0991d7a1a4f81cfd28f736f812689e Mon Sep 17 00:00:00 2001 From: Kjetil Orbekk Date: Tue, 13 Oct 2015 21:03:59 -0400 Subject: Add documentation and license file. --- LICENSE | 37 ++++++++++--------------------------- README.md | 29 +++++++++++++++++++++++++++++ description | 1 + 3 files changed, 40 insertions(+), 27 deletions(-) create mode 100644 README.md create mode 100644 description diff --git a/LICENSE b/LICENSE index a3945cf..88e50b6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,30 +1,13 @@ -Copyright Example Author Name (c) 2015 +Copyright 2015 Kjetil Ørbekk -All rights reserved. +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: + http://www.apache.org/licenses/LICENSE-2.0 - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - - * 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. - - * Neither the name of Example Author Name nor the names of other - 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 -OWNER 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. \ No newline at end of file +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9269e51 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Photos Organizer + +This is a tool to manage local digital photos imported from a camera. + +## Usage + +In nginx.conf: + +```conf + server { + listen [::]:80; + root /path/to/photos-organizer/web; + index index.html; + server_name photos.mydomain; + location / { + try_files $uri $uri/ =404; + } + location /api/ { + proxy_pass http://photos.localhost:8081/; + } + } + +``` + +In another shell: + +``` +stack build && ./run.sh +``` diff --git a/description b/description new file mode 100644 index 0000000..23645f4 --- /dev/null +++ b/description @@ -0,0 +1 @@ +Photos Organizer manages digital photos on a local machin. \ No newline at end of file -- cgit v1.2.3