Initial commit of new readme

README.md

@@ -1,41 +1,128 @@
-# Website
+<a id="readme-top"></a>
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+## How to use this template
+
+Update sheild urls
+
+* Update url for discourse, downloads, issues, current release, and contributors
+
+Project title and logo
+
+* Update project title and description
+* Update project logo
+* Update link to point to documentation about this project
+
+About the project
+
+* Update project screenshot
+* Update the paragraph with what your project is meant to accomplish
+
+Getting started
+
+* Describe how to get started with your project
+* Describe any prerequisites needed to run your project
+* Describe how to install and run your project
+
+Discuss
+
+* Create a tag in our discourse forum for your project
+* Update link in this section to point to the newly created tag
+
+After these steps are complete remove this checklist!
+
+![[Discourse Topics][discourse-shield]][discourse-url]
+![Times Downloaded][downloads-shield]
+![Issues][issues-shield]
+![Latest Releases][release-shield]
+![Contributor Shield][contributor-shield]
+
+[discourse-shield]: https://img.shields.io/discourse/topics?label=Discuss%20This%20Tool&server=https%3A%2F%2Fdeveloper.sailpoint.com%2Fdiscuss
+[discourse-url]: https://developer.sailpoint.com/discuss/
+[downloads-shield]: https://img.shields.io/github/downloads/sailpoint-oss/developer-community-website/total?label=Downloads
+[issues-shield]:https://img.shields.io/github/issues/sailpoint-oss/developer-community-website?label=Issues
+[release-shield]: https://img.shields.io/github/v/release/sailpoint-oss/developer-community-website?label=Current%20Release
+[contributor-shield]:https://img.shields.io/github/contributors/sailpoint-oss/developer-community-website?label=Contributors
+
+[product-screenshot]: ./assets/images/screenshot.png
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+    <img src="./assets/images.logo.svg" alt="Logo" width="80" height="80">
+
+  <h3 align="center">Developer Community Website - README</h3>
+    <br />
+    <br />
+  </p>
+</div>
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+<div align="center">
+<img src="./assets/images/api-linter-output.png" width="500" height="" style="text-align:center">
+</div>
+
+This repository contains the complete build, with assets, for everything seen on developer.sailpoint.com. The includes the homepage, all static elements, docs, and the API specifications. The API specifications come in from a GitHub Action in another repository, but ultimately the API specifications used to generate this static site are those found in the static folder.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+To...
+
+### Prerequisites
+
+To run this project you must first have npm installed.
+* npm
+  ```sh
+  npm install npm@latest -g
+  ```
 
 ### Installation
 
+1. Clone the repo
+   ```sh
+   git clone https://github.com/your_username_/Project-Name.git
    ```
-$ yarn
+2. Install NPM packages
+   ```sh
+   npm install
+   ```
+3. Start the website
+   ```sh
+   npm start
    ```
 
-### Local Development
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-```
-$ yarn start
-```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+<!-- CONTRIBUTING -->
+## Contributing
 
-### Build
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
 
-```
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag `enhancement`.
-$ yarn build
+Don't forget to give the project a star! Thanks again!
-```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/your-feature-name`)
+3. Commit your Changes (`git commit -m 'Add some your-feature-name'`)
+4. Push to the Branch (`git push origin feature/your-feature-name`)
+5. Open a Pull Request
 
-### Deployment
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-Using SSH:
+<!-- LICENSE -->
+## License
 
-```
+Distributed under the MIT License. See `LICENSE.txt` for more information.
-$ USE_SSH=true yarn deploy
-```
 
-Not using SSH:
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-```
+<!-- CONTACT -->
-$ GIT_USER=<Your GitHub username> yarn deploy
+## Discuss
-```
+[Click Here](https://developer.sailpoint.com/dicuss) to discuss this tool with other users.
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+<p align="right">(<a href="#readme-top">back to top</a>)</p>