diff --git a/README.md b/README.md index 96ea01d..2124162 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ # PowerSchool powerschool is a Python client for the [PowerSchool SIS](https://www.powerschool.com/solutions/student-information-system/powerschool-sis) API +## Table of Contents + +* [Installation](#installation) + * [Generate Client ID and Client Secret](#generate-client-id-and-client-secret) +* [Getting Started](#getting-started) +* [Usage](#usage) +* [Contributing](#contributing) +* [Notice](#notice) + ## Installation Use the package manager [pip](https://pip.pypa.io/en/stable/) to install powerschool. ```bash pip install powerschool ``` +#### Generate Client ID and Client Secret + +You can collect the Client ID and Client Secret directly by signing into the PowerSchool Admin portal and navigating to System > System Settings > Plugin Management Dashboard > {Your Plugin}. ## Getting Started 1. Ensure you have a valid [plugin](https://support.powerschool.com/developer/#/page/plugin-xml) installed with the proper data access provisioned for your purposes.