diff --git a/README.md b/README.md index 6b27094..821657f 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ npm install svelte-github-calendar ```svelte @@ -24,24 +24,24 @@ npm install svelte-github-calendar ```svelte - ``` ## Props | Prop | Type | Default | Description | -|----------------|------------|--------------|------------------------------------------| +| -------------- | ---------- | ------------ | ---------------------------------------- | | `username` | `string` | **Required** | GitHub username to display calendar for | | `summary_text` | `string` | `undefined` | Custom summary text template. | | `proxy` | `function` | `undefined` | Custom proxy function for API requests | @@ -65,6 +65,7 @@ This library is licensed under the MIT License. See the [LICENSE](LICENSE) file ## Contributing Contributions are welcome! Feel free to: + - Report bugs - Suggest new features - Submit pull requests @@ -73,5 +74,6 @@ Contributions are welcome! Feel free to: ## Troubleshooting ### Calendar not loading + - Ensure the username is valid and public - Verify network connectivity