diff --git a/README.md b/README.md index d1b5f91..776a238 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,44 @@ -Review allows you to share unpublished entries or revisions with collaborators without having to create a User for them. +## Meet Review -For example, you can create a draft `About Us` page and give folks a URL to view that draft content. You can also share a working copy, if you're using revisions. +Review helps teams streamline content approvals by making it easy to share draft content with anyone. Editors can generate a review URL for any unpublished content and send it to clients, teammates, or stakeholders. Reviewers can immediately view the content without needing a Statamic user account. Review also works with revisions, allowing teams to share the latest working copy of an entry while edits continue. -**Localization:** +### Key Features -To localize the button, add a lang file in `/resources/lang` with the name matching the locale, like `fr.json`. In it put your translation: +- **Share Drafts with Anyone** – Generate a public review link for any unpublished entry. Anyone with the link can view the content. +- **Streamline Content Approvals** – Share review links with stakeholders and collect feedback without slowing down your publishing workflow. +- **Works with Revisions** – Share the latest working copy of an entry while edits continue. -``` -{ - "Copy Review URL to Clipboard": "Translate Me!" -} -``` +--- + +## How It Works + +After installing the addon package via composer, add the Review fieldtype to the sidebar of an entry blueprint. + +The fieldtype provides a "Copy Review URL" button that copies a review link for the entry to your clipboard. This link can then be shared with collaborators. + +The review link displays the unpublished draft or working copy of the entry. + +### Requirements -**Getting the Review URL:** +The "Copy Review URL" button works when: -Review fieldtype: Recommend adding it to the top of the sidebar of any entry blueprint: ![screenshot of copy review url button](https://github.com/transformstudios/statamic-review/raw/main/img/Copy%20URL%20Button.png "Copy Review URL Button") +- The field is added to a blueprint _(not a fieldset due to a Statamic limitation)_ +- The site is served over HTTPS +- The content is not published -**Please note**: +### Things to Know -* Button will only work if: - * the field was added to a blueprint and **not** a fieldset (Statamic issue) - * the site is served via `https` - * content is NOT published -* URLs are public, anyone can view them. -* Once the content is published, visiting that URL redirects to the actual content, unless there is a working copy. +- Review URLs are public. Anyone with the link can access the content. +- When the entry is published, the review URL redirects to the live page unless a working copy exists. + +--- + +## Localization + +To localize the Review fieldtype button text, add a language file in `/resources/lang` matching your locale. For example `ar.json`: + +``` +{ + "Copy Review URL": "انسخ عنوان URL الخاص بالمراجعة" +} +```