From ec3f203edc025a0c298c9dfb2a5d311b7792c52c Mon Sep 17 00:00:00 2001 From: Sveltecasts Date: Mon, 15 Jul 2019 12:31:54 +0200 Subject: [PATCH] Changed Readme --- README.md | 42 ++++++++++++++++++++---------------------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 71e531f..26040ca 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,31 @@ -*Psst — looking for an app template? Go here --> [sveltejs/template](https://github.com/sveltejs/template)* +# About + +This Component allows you to add Youtube-Videos to your Svelte Project + +The orginal Component template comes from [HERE](https://github.com/sveltejs/component-template) + --- -# component-template +# How to use it ? -A base for building shareable Svelte components. Clone it with [degit](https://github.com/Rich-Harris/degit): +Just ```bash -npx degit sveltejs/component-template my-new-component -cd my-new-component -npm install # or yarn +npm install --save-dev @sveltecasts/svelte-youtube +```` + +And in your Source Code under Script: + +``` +import Youtube from "@sveltecasts/svelte-youtube"; + + ``` -Your component's source code lives in `src/index.html`. -TODO +# Btw -* [ ] some firm opinions about the best way to test components -* [ ] update `degit` so that it automates some of the setup work +Here is a youtube video about this component: - -## 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.html`, which allows Svelte apps to import the source code directly, if they are using a bundler plugin like [rollup-plugin-svelte](https://github.com/rollup/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 (`index.mjs`) and a UMD script (`index.js`). This will happen automatically when you publish your component to npm, courtesy of the `prepublishOnly` hook in package.json. +https://www.youtube.com/watch?v=Ank3IdQHOuE \ No newline at end of file