From 0016e6e2ee7b34e38e930305220f9fbd8da38612 Mon Sep 17 00:00:00 2001 From: Michael Erdely Date: Sun, 27 Oct 2024 18:55:06 -0400 Subject: [PATCH] Bring readme to root of repo --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 09c6c8c..4c3a946 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -The README.md for the application is in [src](src/README.md). +# PHP Gift Wishlist + +The PHP Gift Wishlist is a web-enabled gift registry intended for use among +a circle of family members or friends. + +It is intended to fill the following purposes: + +* Permit the long-term storage of a list of items one desires, along with its price, where it can be bought, and (optionally) a URL where it can be + viewed. +* Enabled items to be "locked" by one shopper so that the same item is not bought by someone else. + +Its features include: + +* A single unifying view of items on your own list and people whose lists you can view. +* A now-optional request/permit system by which you can control who can see your list. +* A "checkin/checkout" system which allows you to reserve items on someone's list. +* An in-system messaging system by which users can be informed of item deletions or custom announcements. +* New users can request accounts. Optionally, administrators will be informed about the request, and they can then approve or reject the request. Either way, the user will be informed by e-mail. +* A site-customizable ranking system for items. +* An events system for users to add significant (read: gift-bearing) events which will show up on others' displays when the event nears. + +## Installing + +Read [INSTALL](INSTALL) for installation instructions. + +If you have any questions, comments, feature requests, or patches, feel free to e-mail me. + +## License + +phpgiftreg is licensed by the GPL. For more information on the GPL, visit http://www.gnu.org + +Copyright 2024 Michael Erdely +Copyright 2022 Ryan Walberg [@GeneralPeeEff](https://twitter.com/GeneralPeeEff)