[READ-ONLY] Mirror of https://github.com/flo-bit/svelte-github-corner.
flo-bit.dev/svelte-github-corner/
giving up, updated readme
+29
-52
+29
-39
README.md
+29
-39
README.md
···
1
-
# create-svelte
1
+
# svelte-github-corner
2
2
3
-
Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
3
+
simple little component for adding a github corner icon to your svelte projects
4
4
5
-
Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
6
-
7
-
## Creating a project
8
-
9
-
If you're seeing this, you've probably already done this step. Congrats!
5
+
## install
10
6
11
7
```bash
12
-
# create a new project in the current directory
13
-
npx sv create
14
-
15
-
# create a new project in my-app
16
-
npx sv create my-app
8
+
npm install svelte-github-corner
17
9
```
18
10
19
-
## Developing
11
+
## use
20
12
21
-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
13
+
- the colors are optional, will default to black on white
22
14
23
-
```bash
24
-
npm run dev
15
+
```svelte
16
+
<script>
17
+
import { GithubCorner } from 'svelte-github-corner';
18
+
<\/script>
25
19
26
-
# or start the server and open the app in a new browser tab
27
-
npm run dev -- --open
20
+
<GithubCorner
21
+
href="https://github.com/flo-bit/svelte-github-corner"
22
+
color="#fff"
23
+
backgroundColor="#151513"
24
+
/>
28
25
```
29
26
30
-
Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
27
+
### using with tailwind
31
28
32
-
## Building
29
+
- fill is background, text is icon
33
30
34
-
To build your library:
31
+
```svelte
32
+
<script>
33
+
import { GithubCorner } from 'svelte-github-corner';
34
+
<\/script>
35
35
36
-
```bash
37
-
npm run package
36
+
<GithubCorner
37
+
href="https://github.com/flo-bit/svelte-github-corner"
38
+
class="fill-stone-900 text-stone-100 dark:fill-stone-100 dark:text-stone-900"
39
+
/>
38
40
```
39
41
40
-
To create a production version of your showcase app:
42
+
## license
41
43
42
-
```bash
43
-
npm run build
44
-
```
44
+
MIT
45
45
46
-
You can preview the production build with `npm run preview`.
46
+
## credits
47
47
48
-
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
49
-
50
-
## Publishing
51
-
52
-
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/)).
53
-
54
-
To publish your library to [npm](https://www.npmjs.com):
55
-
56
-
```bash
57
-
npm publish
58
-
```
48
+
based on [github corners](https://github.com/tholman/github-corners) by Tim Holman
-13
.github/workflows/deploy_gh_pages.yml
-13
.github/workflows/deploy_gh_pages.yml
···
32
32
# This should match the `pages` option in your adapter-static options
33
33
path: 'build/'
34
34
35
-
- name: Debug npm auth
36
-
env:
37
-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
38
-
run: |
39
-
echo "Auth token length: ${#NODE_AUTH_TOKEN}"
40
-
41
-
- name: Publish to NPM
42
-
env:
43
-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
44
-
run: |
45
-
npm install
46
-
npm publish --access public
47
-
48
35
deploy:
49
36
needs: build_site
50
37
runs-on: ubuntu-latest