Merge pull request #10 from MatthiesenXYZ/dev

update

.changeset/lucky-rockets-chew.md

@@ -0,0 +1,5 @@
+---
+"@matthiesenxyz/astro-gists": patch
+---
+
+Update README and add example image

README.md

@@ -1,30 +1 @@
-# `Astro-Gists`
-
-Allows the user to import GitHub Gists by ID through an Astro Component and Octokit
-
-To see how to get started, check out the [package README](./package/README.md)
-
-## Contributing
-
-This package is structured as a monorepo:
-
-- `playground` contains code for testing the package
-- `package` contains the actual package
-
-Install dependencies using pnpm: 
-
-```bash
-pnpm i --frozen-lockfile
-```
-
-Start the playground:
-
-```bash
-pnpm playground:dev
-```
-
-You can now edit files in `package`. Please note that making changes to those files may require restarting the playground dev server.
-
-## Licensing
-
-[MIT Licensed](./LICENSE). Made with ❤️ by [AdamMatthiesen](https://github.com/AdamMatthiesen) Under [MatthiesenXYZ](https://github.com/MatthiesenXYZ).
+./package/README.md

package/README.md

@@ -2,11 +2,15 @@
 
 This is an [Astro integration](https://docs.astro.build/en/guides/integrations-guide/) that allows the user to import GitHub Gists by ID through an Astro Component and Octokit
 
+## Example
+
+![Example of AstroGists in use](./src/assets/example.png)
+
 ## Usage
 
 ### Prerequisites
 
-The Only Requirement to install this package is a **Github account with a Varified Email** to be able to create a Personal Access Token.
+The Only Requirement to install this package is a **Github account with a Verified Email** to be able to create a Personal Access Token.
 
 This Integration uses [`Octokit`](http://octokit.github.io/) by `GitHub` to Generate custom gists using [`ExpressiveCode`](https://expressive-code.com/) within your Astro project!
 
@@ -83,6 +87,27 @@ import { GetGist } from "@matthiesenxyz/astro-gists/components"
 />
 ```
 
+## Contributing
+
+This package is structured as a monorepo:
+
+- `playground` contains code for testing the package
+- `package` contains the actual package
+
+Install dependencies using pnpm: 
+
+```bash
+pnpm i --frozen-lockfile
+```
+
+Start the playground:
+
+```bash
+pnpm playground:dev
+```
+
+You can now edit files in `package`. Please note that making changes to those files may require restarting the playground dev server.
+
 ## Licensing
 
 [MIT Licensed](./LICENSE). Made with ❤️ by [AdamMatthiesen](https://github.com/AdamMatthiesen) Under [MatthiesenXYZ](https://github.com/MatthiesenXYZ).
@@ -90,4 +115,5 @@ import { GetGist } from "@matthiesenxyz/astro-gists/components"
 ## Acknowledgements
 
 - [`Octokit`](http://octokit.github.io) by GitHub
-- [`Expressive-Code`](https://expressive-code.com/) By Hippotasic
+- [`Expressive-Code`](https://expressive-code.com/) By Hippotasic
+- [`astro-integration-kit`](https://github.com/florian-lefebvre/astro-integration-kit) by Florian

playground/src/pages/index.astro

@@ -1,9 +1,9 @@
 ---
 import { GetGist } from "@matthiesenxyz/astro-gists/components"
 ---
-<h1>Testing</h1>
+<h1>Dev: Playground</h1>
 
 <GetGist 
-	gistId="ff6704ff48e79f45ce5f7c47932bffab"
-	filename="authentik.yaml" 
+	gistId="cce7f3f1d9322710be8196aa344186ba"
+	filename="hello.md" 
 />