diff --git a/README.md b/README.md index a3eeca0..955ac36 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Saviynt Connectors -This is a repo for Saviynt Connector Packages built for the REST Connector as Community Sourced Integrations posted on Saviynt Exchange. +This is a repo for Saviynt Connector Packages built for the REST Connector as [Community Sourced Integrations posted on Saviynt Exchange](https://forums.saviynt.com/t5/community-sourced-integrations/tkb-p/se-community-integration). This repo currently covers the files available at the following locaitons: @@ -15,4 +15,11 @@ This repo currently covers the files available at the following locaitons: 1. [SAP Business Technology Platform](https://forums.saviynt.com/t5/community-sourced-integrations/sap-business-technology-platform-sap-btp-integration-guide/ta-p/68010) - [website](https://www.sap.com/products/technology-platform.html) 1. [ServiceDesk Plus](https://forums.saviynt.com/t5/community-sourced-integrations/servicedesk-plus-integration-guide/ta-p/53548) - [website](https://www.manageengine.com/products/service-desk/) 1. [Signal Sciences](https://forums.saviynt.com/t5/community-sourced-integrations/signal-sciences-integration-guide/ta-p/50270) - [website](https://www.signalsciences.com/) -1. [TeamConnect](https://forums.saviynt.com/t5/community-sourced-integrations/teamconnect-integration-guide/ta-p/65149) - [website](https://www.teamconnectusa.com/) \ No newline at end of file +1. [TeamConnect](https://forums.saviynt.com/t5/community-sourced-integrations/teamconnect-integration-guide/ta-p/65149) - [website](https://www.teamconnectusa.com/) + +## Contributions + +### Adding A Connector + +1. To add a connector, create a folder under `src/connectors` using the same name as the `templateName`. Do not add files to `docs` folder. The contents of this folder are autogenerated by `mkdocs`. +1. Write the `Connection` and `ObjectSummary` files in JSON format. Also include a zip files comprisong the two JSON files with the name `${templateName}.zip`.