mike/wishlist
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

convert README to Markdown

Browse source
This commit is contained in:
Ryan Walberg 2022-07-23 14:14:21 -04:00
parent 126807e01b
commit 43a798cf4d
3 changed files with 33 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md Normal file
View file

@ -0,0 +1 @@
The README.md for the application is in [src](src/README.md).

37
src/README
View file

@ -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

32
src/README.md Normal file
View file

@ -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)