Add Modal

README.md

@@ -17,6 +17,28 @@ pnpm install # Install dependencies
 pnpm dev # Run dev server
 ```
 
+### Adding new components
+
+> Replace `ComponentName` with your component name in the steps below
+
+1. Create a `ComponentName.svelte` file in `src/package/components`
+2. Add an export for your component in [./src/package/index.ts](./src/package/index.ts)
+   ```
+   export { default as ComponentName } from './components/ComponentName.svelte'
+   ```
+3. Create a `ComponentName.md` file for documentation in `src/routes/components`
+4. Add an example of your component in your `ComponentName.md` file, like so:
+
+   ````md
+   ```svelte example raised
+   <script lang="ts">
+   	import { ComponentName } from 'omorphia'
+   </script>
+
+   <ComponentName />
+   ```
+   ````
+
 ## Packaging
 
 ```bash