From 38ffa09d5cb3b1d519515891cd62a8ef092184a4 Mon Sep 17 00:00:00 2001 From: alyx Date: Thu, 30 May 2024 13:25:01 -0400 Subject: README, copyright notice --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7072661..533b0c9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ # visitors_dot_php A single-php-file guestbook with customizability and ease-of-deployment in mind. + +**Current version: `0.0.1`.** + +The first number is reserved for future use. +The second number is the database version. +The third number is the non-database revision. + +## Hosting + +To deploy, edit the top of `visitors.php` with your desired configuration, and then upload it to your webserver or hosting provider. +It must support client-side scripting, so Github Pages, Neocities, etc. are all out of the question. + +There are no security risks to your database file being publically accessible, as it only contains the same info the page will display. +This may change in a future release. + +## Contact Me + +I can be reached at [`alyx@aleteoryx.me`](mailto:alyx@aleteoryx.me) via e-mail, and [`@admin@mk.aleteoryx.me`](https://mk.aleteoryx.me/@admin) on the fediverse. +Additionally, any of the methods listed on [my website](https://aleteoryx.me/) work too. DM me on Tumblr or something idc lol. +Please contact for feature requests, bug reports, and other concerns. + +The default style is not great, and not my best work, but it's there more as a proof-of-concept than anything. +If you would like to contribute a better style, please get in touch! + +## Legal + +``` +Copyright (C) 2024 by Aleteoryx + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +``` -- cgit v1.2.3-54-g00ecf