blue-comments
Advanced tools
Comparing version 1.0.0-alpha to 1.0.0-alpha2
{ | ||
"name": "blue-comments", | ||
"author": "aendra", | ||
"version": "1.0.0-alpha", | ||
"version": "1.0.0-alpha2", | ||
"scripts": { | ||
@@ -6,0 +6,0 @@ "dev": "vite dev", |
@@ -1,58 +0,19 @@ | ||
# create-svelte | ||
# BlueComments | ||
Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte). | ||
## Bluesky commenting system | ||
Read more about creating a library [in the docs](https://kit.svelte.dev/docs/packaging). | ||
Heavily inspired by https://graysky.app/blog/2024-02-05-adding-blog-comments | ||
## Creating a project | ||
To use — | ||
If you're seeing this, you've probably already done this step. Congrats! | ||
#### In your `<head>` section: | ||
```bash | ||
# create a new project in the current directory | ||
npm create svelte@latest | ||
# create a new project in my-app | ||
npm create svelte@latest my-app | ||
``` | ||
## Developing | ||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: | ||
```bash | ||
npm run dev | ||
# or start the server and open the app in a new browser tab | ||
npm run dev -- --open | ||
<script type="module" async defer src="https://esm.sh/blue-comments"></script> | ||
``` | ||
Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app. | ||
#### Where you want to put comments: | ||
## Building | ||
To build your library: | ||
```bash | ||
npm run package | ||
``` | ||
To create a production version of your showcase app: | ||
```bash | ||
npm run build | ||
<blue-comments uri="at://did:plc:.../app.bsky.feed.post/..."> | ||
``` | ||
You can preview the production build with `npm run preview`. | ||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. | ||
## Publishing | ||
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/)). | ||
To publish your library to [npm](https://www.npmjs.com): | ||
```bash | ||
npm publish | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1696197
20