astro-gists/README.md

31 lines
770 B
Markdown
Raw Normal View History

2024-02-24 03:34:15 +00:00
# `Astro-Gists`
2024-02-24 02:44:44 +00:00
2024-02-24 03:34:15 +00:00
Allows the user to import GitHub Gists by ID through an Astro Component and Octokit
2024-02-24 02:44:44 +00:00
To see how to get started, check out the [package README](./package/README.md)
2024-02-24 03:34:15 +00:00
## 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.
2024-02-24 02:44:44 +00:00
## Licensing
2024-02-24 03:34:15 +00:00
[MIT Licensed](./LICENSE). Made with ❤️ by [AdamMatthiesen](https://github.com/AdamMatthiesen) Under [MatthiesenXYZ](https://github.com/MatthiesenXYZ).