diff --git a/README.md b/README.md index 41412ae..d2dbfcb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ # Stirling-PDF-Docs -Documentation for Stirling-PDF using docusarus +Documentation for Stirling-PDF using [Docusaurus](https://docusaurus.io/) +Final version is hosted [here](https://docs.stirlingpdf.com/) -Users are welcome to request or update documentation +## Prerequisites + +- [Node.js](https://nodejs.org/en/download) version 16.14 or above +- npm or yarn package manager + +## Setup + +1. Install dependencies: +```bash +npm install +``` + +2. Start the development server: +```bash +npm start +``` + +The site will be available at `http://localhost:3000` + +## Contributing + +Contributions are welcome! To add or update documentation: + +1. Create or edit markdown files in the `docs/` directory +2. Preview changes locally using `npm start` +3. Submit a pull request