Skip to content

Commit

Permalink
add the registry feature to the readme (#122)
Browse files Browse the repository at this point in the history
  • Loading branch information
cmintey authored Jul 23, 2024
1 parent 5a433c6 commit 5b77929
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Wishlist is a self-hosted wishlist application that you can share with your frie
- [x] Options for [suggestions](#suggestions)
- [x] PWA Support
- [x] Group support
- [x] Registry Mode
- [ ] Draw names for a "secret santa" experience

## Getting Started
Expand Down Expand Up @@ -56,6 +57,12 @@ Wishlist has support for multiple wishlist groups. For example, you can have one

Currently, anyone can create a group. The group creator is automatically added as a "manager" of the group. A Group Manager can invite users to Wishlist and add/remove existing users to the group they manage. The Group Manager can also delete the group. An Admin will have the same permissions as the Group Manager.

## Registry Mode

Wishlist has the ability to turn a group into a Registry. In this mode, only a single user can be part of the group and there is only one list. The owner of the group can add items to the list as normal and then get a public link to share out to friends and family. Users accessing this link will not need to sign in or create an account. Public users can view the items on the list and also claim items. In order to claim an item, the user just needs to enter some identifier (email for example) and can optionally add their name. Currently there is no way to un-claim items that are claimed in this manner.

To activate this mode, go to the admin panel of your group and change the mode from "Wishlist" to "Registry".

## Configuration

There are several configuration options in the admin panel.
Expand Down

0 comments on commit 5b77929

Please sign in to comment.