diff --git a/README.md b/README.md index afaa2af..5fe72fd 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,24 @@ Access your Promoter feedback and score data from within Zendesk. ## Installation 1. [Download the latest app package](https://github.com/delivered/promoter-zendesk/releases/latest) - File will be available in the "Downloads" section and look something like `app-YYYYMMDDHHMMSS.zip`. -2. Browse to your Zendesk Apps Management Screen (https://{your-subdomain}.zendesk.com/agent/admin/apps/manage) - [Screenshot](https://cl.ly/010k3C3E3k1s) +2. Browse to your Zendesk Apps Management Screen (https://{your-subdomain}.zendesk.com/agent/admin/apps/manage) 3. Click "Upload private app" -4. Enter the name of the app - "Promoter" is recommended - [Screenshot](https://cl.ly/061o2q0l322y) +4. Enter the name of the app - "Promoter" is recommended 5. Choose the zip file downloaded in step 1 6. Click "Upload" -7. Approve the terms and conditions by clicking a second "Upload" - [Screenshot](https://cl.ly/0T0E2I3o2F2u) -8. Enter your Promoter API key and Promoter Subdomain - [Screenshot](https://cl.ly/0Z2q2R241A02) +7. Approve the terms and conditions by clicking a second "Upload" +8. Enter your Promoter API key 9. Click "Install" ## Usage -// +After the app has been successfully installed and enabled, it will show up in the right pane of the User and Ticket views within Zendesk. + +Upon initial load of the User Profile or Ticket, the app will search for feedback records in your Promoter account associated with the User's primary email address or Ticket Requestors email address. + +When feedback data is found a list of all the feedback events will be displayed. These list items will include the score and score level. Each list item can be expanded to reveal the details of the feedback. + +Also presented will be an average score. The average score is computed client-side based on all the feedback data returned. ## Contributing diff --git a/translations/en.json b/translations/en.json index 7604cdc..1d78647 100644 --- a/translations/en.json +++ b/translations/en.json @@ -15,38 +15,18 @@ } } }, - "loading": "Welcome to this Sample App", - "fetch": { - "done": "Good", - "fail": "failed to fetch information from the server" - }, - "id": "ID", - "email": "Email", - "name": "Name", - "role": "Role", - "groups": "Groups", "callToActions": { - "all_customers": "All Customer Records", "back": "Back" }, "customerPage": { "title": "Customer" }, - "searchPage": { - "title": "Search Results", - "exclamation": "Welp!", - "no_customers_found": "No customer data could be found." - }, "settingsPage": { "title": "Settings", "api_key": { "value": "API Key", "title": "Your API key from promoter" }, - "subdomain": { - "value": "Subdomain", - "title": "Your promoter subdomain" - }, "instruction": { "value": "Copy the command below and paste into your terminal to update app settings using a Zendesk App API that can be found in Settings > Channels > API.", "title": "Instruction message asking the user to copy and paste the command below to terminal"