📖 Update README.md to reflect library name and usage examples for svelte-github-calendar

README.md

@@ -1,58 +1,77 @@
-# Svelte library
+# svelte-github-calendar
 
-Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
+A Svelte wrapper of the [github-calendar](https://github.com/Bloggify/github-calendar) library to displays GitHub contribution graphs in your Svelte applications.
 
-Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
+## Installation
 
-## Creating a project
-
-If you're seeing this, you've probably already done this step. Congrats!
-
-```sh
-# create a new project in the current directory
-npx sv create
-
-# create a new project in my-app
-npx sv create my-app
+```bash
+npm install svelte-github-calendar
 ```
 
-## Developing
+## Usage
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+### Basic Example
 
-```sh
-npm run dev
+```svelte
+<script>
+  import { GithubCalendar } from 'svelte-github-calendar';
+</script>
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+<GithubCalendar username="yourusername" />
 ```
 
-Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
+### Advanced Example
 
-## Building
+```svelte
+<script>
+  import { GithubCalendar } from 'svelte-github-calendar';
+</script>
 
-To build your library:
-
-```sh
-npm pack
+<GithubCalendar 
+  username="yourusername"
+  summary_text="Summary of {name}'s GitHub activity"
+  global_stats={true}
+  responsive={true}
+  tooltips={true}
+  cache={60}
+  class="my-custom-class"
+/>
 ```
 
-To create a production version of your showcase app:
+## Props
 
-```sh
-npm run build
-```
+| 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   |
+| `global_stats` | `boolean`  | `undefined`  | Whether to show global statistics        |
+| `responsive`   | `boolean`  | `undefined`  | Enable responsive design                 |
+| `tooltips`     | `boolean`  | `undefined`  | Enable hover tooltips                    |
+| `cache`        | `number`   | `undefined`  | Cache duration in seconds                |
+| `class`        | `string`   | `''`         | Additional CSS classes for the container |
 
-You can preview the production build with `npm run preview`.
+You can read more about the props in the [original documentation](https://github.com/Bloggify/github-calendar).
 
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+## Credits
 
-## Publishing
+- Svelte wrapper of [github-calendar](https://github.com/Bloggify/github-calendar) by Bloggify
+- Designed specifically for Svelte applications
 
-Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).
+## License
 
-To publish your library to [npm](https://www.npmjs.com):
+This library is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
-```sh
-npm publish
-```
+## Contributing
+
+Contributions are welcome! Feel free to:
+- Report bugs
+- Suggest new features
+- Submit pull requests
+- Improve documentation
+
+## Troubleshooting
+
+### Calendar not loading
+- Ensure the username is valid and public
+- Verify network connectivity