diff --git a/README.md b/README.md index b5b2950..8e7b1da 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,111 @@ -# sv +# svidentity -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +**A dead simple Svelte-based identity provider with callback support that’s easy to integrate with.** -## Creating a project +--- -If you're seeing this, you've probably already done this step. Congrats! +## Features -```bash -# create a new project in the current directory -npx sv create +- **Simple Integration**: Built with simplicity in mind, making it easy to integrate with your existing projects. +- **Svelte-Powered**: Lightweight and fast frontend using Svelte. +- **Callback Support**: Seamlessly handle authentication callbacks for a smooth user experience. +- **Customizable**: Easily adapt the provider to fit your specific authentication requirements. -# create a new project in my-app -npx sv create my-app -``` +--- -## Developing +## Getting Started -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +### Prerequisites -```bash -npm run dev +Before setting up svidentity, ensure you have the following installed: -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +- [Node.js](https://nodejs.org/) (v16+ recommended) +- [npm](https://www.npmjs.com/) or [pnpm](https://pnpm.io/) -## Building +### Installation -To create a production version of your app: +1. Clone the repository: -```bash -npm run build -``` + ```bash + git clone https://github.com/owenrummage/svidentity.git + cd svidentity + ``` -You can preview the production build with `npm run preview`. +2. Install dependencies: -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. + ```bash + npm install + # or + pnpm install + ``` + +3. Start the development server: + + ```bash + npm run dev + ``` + + By default, the application will be available at `http://localhost:5173`. + +--- + +## Configuration + +### Environment Variables + +Create a `.env` file in the root directory to configure your environment. The following variables are supported: + +- `DATABASE_URL`: Your database URL for data storage + +### Customization + +To customize svidentity, modify the Svelte components located in the `src/routes` directory. Key files include: + +- `src/routes/login/+page.svelte`: The login page. +- `src/routes/reigster/+page.svelte`: Displays user information. + +--- + +## Contributing + +Contributions are welcome! If you’d like to contribute to svidentity, please follow these steps: + +1. Fork the repository. + +2. Create a new branch: + + ```bash + git checkout -b feature/your-feature-name + ``` + +3. Make your changes and commit them: + + ```bash + git commit -m "Add your feature description" + ``` + +4. Push to your branch: + + ```bash + git push origin feature/your-feature-name + ``` + +5. Open a pull request. + +--- + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. + +--- + +## Contact + +For questions or support, please contact **Owen Rummage** via [GitHub Issues](https://github.com/owenrummage/svidentity/issues). + +--- + +## Acknowledgments + +Special thanks to the Svelte community for their tools and resources.