svelte-share-buttons-component
Advanced tools
Comparing version 1.0.0 to 1.0.1
@@ -24,3 +24,3 @@ { | ||
"description": "*Psst — looking for an app template? Go here --> [sveltejs/template](https://github.com/sveltejs/template)*", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"repository": { | ||
@@ -27,0 +27,0 @@ "type": "git", |
@@ -1,35 +0,8 @@ | ||
*Psst — looking for an app template? Go here --> [sveltejs/template](https://github.com/sveltejs/template)* | ||
# svelte-share-buttons-component | ||
--- | ||
## Installation | ||
# component-template | ||
A base for building shareable Svelte components. Clone it with [degit](https://github.com/Rich-Harris/degit): | ||
```bash | ||
npx degit sveltejs/component-template my-new-component | ||
cd my-new-component | ||
npm install # or yarn | ||
Using npm: | ||
``` | ||
Your component's source code lives in `src/Component.svelte`. | ||
You can create a package that exports multiple components by adding them to the `src` directory and editing `src/index.js` to reexport them as named exports. | ||
TODO | ||
* [ ] some firm opinions about the best way to test components | ||
* [ ] update `degit` so that it automates some of the setup work | ||
## Setting up | ||
* Run `npm init` (or `yarn init`) | ||
* Replace this README with your own | ||
## Consuming components | ||
Your package.json has a `"svelte"` field pointing to `src/index.js`, which allows Svelte apps to import the source code directly, if they are using a bundler plugin like [rollup-plugin-svelte](https://github.com/sveltejs/rollup-plugin-svelte) or [svelte-loader](https://github.com/sveltejs/svelte-loader) (where [`resolve.mainFields`](https://webpack.js.org/configuration/resolve/#resolve-mainfields) in your webpack config includes `"svelte"`). **This is recommended.** | ||
For everyone else, `npm run build` will bundle your component's source code into a plain JavaScript module (`dist/index.mjs`) and a UMD script (`dist/index.js`). This will happen automatically when you publish your component to npm, courtesy of the `prepublishOnly` hook in package.json. | ||
$ npm i --save svelte-share-buttons-component | ||
``` |
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
79201
8