Documentation and license

README.md

@@ -1,7 +1,36 @@
-# www-app-microjournal
-
-A tiny self-hostable "microjournaling" web app. Helps fill the void when abstaining from social media by encouraging journaling small thoughts throughout the day.
+# Microjournal
+
+A tiny self-hostable "microjournaling" web app. Helps fill the void when abstaining from social media by encouraging journaling small thoughts throughout the day instead of doomscrolling! Inspired by a [video by struthful](https://www.youtube.com/watch?v=mFvdHfhVIsQ) on YouTube.
+
+Features:
+
+- Post plain text entries to a simple private blog timeline
+- Light/dark mode support
+- No Javascript
+- Works as a nice little web app when bookmarked to the home screen on iOS
 
 # Requirements
 
-- web host with PHP
+- Web host with PHP 8.1
+
+# Installation
+
+1. Copy all the files in `htdocs` to your web directory.
+2. Copy `journal.db` somewhere **outside** your web directory so it is not accessible from the internet.
+3. Ensure `journal.db` is writable by the web server user. The web app will test writability when it is first run and will alert you if it fails.
+4. Edit `index.php` and set the configuration values near the top:
+    - `DB_PATH` is the path to `journal.db` on the server's file system.
+    - `BASE_URL` is the URL where `index.php` will be accessed from the web. An `https:` URL is strongly recommended. You may include `index.php` in the URL or just point to the path.
+5. Load the URL in a browser. If there are any configuration problems, you'll be notified. Otherwise, you will be prompted to create a username and password. The username can be an email address or a simple username.
+
+Optionally, since there isn't anything here you'd want other people accessing, you may want to add a [`robots.txt`](https://en.wikipedia.org/wiki/Robots.txt) to your website to keep your journal undiscovered by search engines.
+
+# Future features (maybe)
+
+- Deleting posts
+- Editing posts
+- Simple markdown support
+
+# License
+
+This software is under the [MIT Software License](https://mit-license.org/).

htdocs/index.php

@@ -1,4 +1,24 @@
 <?php declare(strict_types=1);
+// Copyright © 2023 Ian Albert
+//
+// 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 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.
+
 
 
 // --------------------------------------------------------