From 43a798cf4d4c7b96c7a451ef969ec0466541f6e8 Mon Sep 17 00:00:00 2001 From: Ryan Walberg <generalpf@gmail.com> Date: Sat, 23 Jul 2022 14:14:21 -0400 Subject: [PATCH] convert README to Markdown --- README.md | 1 + src/README | 37 ------------------------------------- src/README.md | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 33 insertions(+), 37 deletions(-) create mode 100644 README.md delete mode 100644 src/README create mode 100644 src/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..09c6c8c --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +The README.md for the application is in [src](src/README.md). diff --git a/src/README b/src/README deleted file mode 100644 index c3955b7..0000000 --- a/src/README +++ /dev/null @@ -1,37 +0,0 @@ -PHP Gift Registry (phpgiftreg) - -The PHP Gift Registry 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: -x 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. -x Enabled items to be "locked" by one shopper so that the same item is not - bought by someone else. - -Its features include: -x A single unifying view of items on your own list and people whose lists you - can view. -x A now-optional request/permit system by which you can control who can see - your list. -x A "checkin/checkout" system which allows you to reserve items on someone's - list. -x An in-system messaging system by which users can be informed of item - deletions or custom announcements. -x 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. -x A site-customizable ranking system for items. -x An events system for users to add significant (read: gift-bearing) events - which will show up on others' displays when the event nears. - -Read INSTALL for installation instructions. - -If you have any questions, comments, feature requests, or patches, feel -free to e-mail me. - -phpgiftreg is licensed by the GPL. For more information on the GPL, visit -http://www.gnu.org - -Copyright 2012 Ryan Walberg <generalpf@gmail.com> @GeneralPF diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..5595feb --- /dev/null +++ b/src/README.md @@ -0,0 +1,32 @@ +# PHP Gift Registry (phpgiftreg) + +The PHP Gift Registry 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 2022 Ryan Walberg <generalpf@gmail.com> [@GeneralPeeEff](https://twitter.com/GeneralPeeEff)