Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added new documentation links
  • Loading branch information
JodieM authored Feb 20, 2024
1 parent 2a51dbe commit 3ef6623
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

With Salesforce Indicators, you can visually highlight important data at a glance, making it easy to focus on what matters most. This Custom Metadata driven Lightning Web Component is all about making key details pop, and giving you lightning-quick insights at a glance on your Salesforce records.


Features:
* Visualize your data - Display key details in a visually engaging and clutter-free manner, allowing users to quickly understand important information on the record, summarize related records, or highlight exceptions.
* Make your data come alive - Add a mix of Salesforce and custom colors to match your branding to create visually appealing indicators for your Lightning pages giving your users a more engaging experience.
Expand All @@ -14,38 +13,39 @@ Salesforce Indicators is part of the [Salesforce Open Source Commons](https://he

## Latest Release
* [Install Salesforce Indicators](https://install.salesforce.org/products/indicators)
* [Release Notes](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/Release-Notes)
* [Release Notes](https://sfdo-community-sprints.github.io/indicators-documentation/docs/release-notes/)

## Project Documentation
* Documentation can be found in the repository [Wiki](https://github.com/SFDO-Community/Salesforce-Indicators/wiki).
* Check out the [Cookbook](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/Cookbook) to help you build Indicators that work for your org.
* Documentation can be found on our [Documentation Site](https://sfdo-community-sprints.github.io/indicators-documentation/).
* Check out the [Getting Started with Salesforce Indicators](https://sfdo-community-sprints.github.io/indicators-documentation/docs/getting-started/) page to help get started with how to set up Salesforce Indicators in your org.

## Ask Questions and Get Help
* Salesforce Indicators is a community built and maintained Salesforce package, please help support this project and share your experiences in the [Trailblazer Community Group](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000HEDASA4?tab=discussion). Ask any questions about the Salesforce Indicators project, or the Open Source Commons.
* If you have any enhancements or issue you can [Log an Issue](https://github.com/SFDO-Community/Salesforce-Indicators/issues).
* If you have any enhancements or issue you can [Log an Issue](https://github.com/SFDO-Community/Salesforce-Indicators/issues)

## Vision & Goals
* Enhance the current Indicators Bundle Component to improve the experience for Admins and Users.
* Complete the documentation with different recipes to help Admins get up and running quickly.
* Showcase and review different apps you can use to achieve similar results, and show how you will probably want to use Salesforce Indicators anyway.
* Build our planned Components - these components are built on the same Custom Metadata framework and just show the data in different ways:
* A Grid Component to quickly show your users excptions or a checklist of fields on the record. Optionally show field values, a custom message for each field, and if the field has an exception.
* A Grid Component to quickly show your users excptions or a checklist of fields on the record. Optionally show field values, a custom message for each field, and if the field has an exception.
* A Panel Component to provide more value and features than the standard record highlights panel horizontally, or a panel that display the key data vertically.

# How to Contribute:
- [Install Salesforce Indicators](https://install.salesforce.org/products/indicators)
- [Set up the Indicator Bundle](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/Indicator-Bundle)
- [Set up Salesforce Indicators](https://sfdo-community-sprints.github.io/indicators-documentation/docs/setup-salesforce-indicators/)
- Ask any questions on our [Trailblazer Community Group](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000HEDASA4?tab=discussion)
- Add your own Recipes to the [Cookbook](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/Cookbook) and
- Add reviews of any [similar or competitor components](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/Other-Apps-and-Components-to-Enhance-Your-Org)
- Add your own [Recipes](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/Cookbook) to our documentation
- Add reviews of any [similar or competitor components](https://sfdo-community-sprints.github.io/indicators-documentation/docs/components/other-solutions/)
- [Volunteer](https://github.com/SFDO-Community/Salesforce-Indicators/wiki/How-to-Volunteer) to enhance the code
- [Log an Issue](https://github.com/SFDO-Community/Salesforce-Indicators/issues)
- Join us at an upcoming [Salesforce Commons Community Sprint](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000GwVK?tab=discussion)

## Project Acomplishments
* Rebuilt the component to support Custom Metadata Types
* Built the component to support Custom Metadata Types
* Enhancements to the Indicator Bundle Component
* The Indicator Key compnent and Setup components to help build and understand the Indicators easily
* New companion components (Grid and Panel) in progress
* Packaging and release setup
* Marketing and release of Salesforce Indicators
* New UI for building Salesforce Indicators in progress

0 comments on commit 3ef6623

Please sign in to comment.