Paillat-dev/svelte-github-calendar
1
0
Fork 0
mirror of https://github.com/Paillat-dev/svelte-github-calendar.git synced 2026-01-02 01:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

🎨 Format README.md

Browse Source
This commit is contained in:
Paillat
2025-08-28 18:18:46 +02:00
parent db1bc9803d
commit d16e4b2f1f
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -14,7 +14,7 @@ npm install svelte-github-calendar
```svelte ```svelte
<script> <script>
import { GithubCalendar } from 'svelte-github-calendar'; import { GithubCalendar } from 'svelte-github-calendar';
</script> </script>
<GithubCalendar username="yourusername" /> <GithubCalendar username="yourusername" />
@@ -24,24 +24,24 @@ npm install svelte-github-calendar
```svelte ```svelte
<script> <script>
import { GithubCalendar } from 'svelte-github-calendar'; import { GithubCalendar } from 'svelte-github-calendar';
</script> </script>
<GithubCalendar <GithubCalendar
username="yourusername" username="yourusername"
summary_text="Summary of {name}'s GitHub activity" summary_text="Summary of {name}'s GitHub activity"
global_stats={true} global_stats={true}
responsive={true} responsive={true}
tooltips={true} tooltips={true}
cache={60} cache={60}
class="my-custom-class" class="my-custom-class"
/> />
``` ```
## Props ## Props
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
|----------------|------------|--------------|------------------------------------------| | -------------- | ---------- | ------------ | ---------------------------------------- |
| `username` | `string` | **Required** | GitHub username to display calendar for | | `username` | `string` | **Required** | GitHub username to display calendar for |
| `summary_text` | `string` | `undefined` | Custom summary text template. | | `summary_text` | `string` | `undefined` | Custom summary text template. |
| `proxy` | `function` | `undefined` | Custom proxy function for API requests | | `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 ## Contributing
Contributions are welcome! Feel free to: Contributions are welcome! Feel free to:
- Report bugs - Report bugs
- Suggest new features - Suggest new features
- Submit pull requests - Submit pull requests
@@ -73,5 +74,6 @@ Contributions are welcome! Feel free to:
## Troubleshooting ## Troubleshooting
### Calendar not loading ### Calendar not loading
- Ensure the username is valid and public - Ensure the username is valid and public
- Verify network connectivity - Verify network connectivity