svelte-animated-icon 1.0.0 → 1.0.1

package/README.md

@@ -1,65 +1,26 @@
-# Svelte library
+# Svelte Animated Icon
 
-Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
+Svelte Animated Icon is a Svelte 5 animated icon library - tree-shakeable, multi-library, and powered by the native Web Animations API. Created by Fractaldesign.
 
-Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
+## Project
 
-## Creating a project
+- **Github:** This repo at [Github](https://github.com/fractalmandala/svelte-animated-icon).
+- **Built with:** SvelteKit 2, Svelte 5, the `@sveltejs/package` packaging tool, and `mdsvex` for these docs.
+- **Animation engine:** the browser's Web Animations API. No animation library dependency.
+- **Site:** [www.svelte-animated-icon.vercel.app/](https://svelte-animated-icon.vercel.app/).
+- **Getting Started:** [Start Here](/docs/01-introduction).
 
-If you're seeing this, you've probably already done this step. Congrats!
+[![npm version](https://img.shields.io/npm/v/svelte-animated-icon.svg)](https://www.npmjs.com/package/svelte-animated-icon)
 
-```sh
-# create a new project in the current directory
-npx sv create
+## How this site is structured
 
-# create a new project in my-app
-npx sv create my-app
-```
+The package and the docs site share a single SvelteKit project:
 
-To recreate this project with the same configuration:
+- `src/lib/` is the **package source** - `AnimatedIcon`, the templates, and the generated icon files.
+- `src/routes/` is the **docs site** you're reading. The home route is an interactive explorer; everything under `/docs` is an `.md` file compiled by mdsvex.
+- `scripts/generate.js` reads source SVGs and writes the per-icon `.svelte` files.
+- `static/svg/` holds the raw Phosphor and Remix source SVGs.
 
-```sh
-# recreate this project
-pnpm dlx sv@0.16.1 create --template library --types ts --add prettier eslint sveltekit-adapter="adapter:vercel" mdsvex --install pnpm svelte-animated-icon
-```
+## License
 
-## Developing
-
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
-
-```sh
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
-
-Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
-
-## Building
-
-To build your library:
-
-```sh
-npm pack
-```
-
-To create a production version of your showcase app:
-
-```sh
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/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):
-
-```sh
-npm publish
-```
+The package's own source code is released under the license declared in `package.json`. The icons are MIT. See [License](/docs/05-license.md)

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "svelte-animated-icon",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fractalmandala/svelte-animated-icon.git"
+  },
   "files": [
     "dist",
     "!dist/**/*.test.*",
@@ -43,6 +47,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@formkit/auto-animate": "^0.9.0",
     "@sveltejs/adapter-vercel": "^6.3.3",
     "@sveltejs/kit": "^2.63.0",
     "@sveltejs/package": "^2.5.8",
@@ -66,9 +71,6 @@
   "keywords": [
     "svelte"
   ],
-  "dependencies": {
-    "@formkit/auto-animate": "^0.9.0"
-  },
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run prepack",

package/dist/utils/globalstores.d.ts

@@ -1,2 +0,0 @@
-export declare const darkTheme: import("svelte/store").Writable<any>;
-export declare function toggleTheme(): void;

package/dist/utils/globalstores.js

@@ -1,13 +0,0 @@
-import { writable } from 'svelte/store';
-import { browser } from '$app/environment';
-const storedDarkTheme = browser ? JSON.parse(localStorage.getItem('darkTheme') || 'false') : false;
-export const darkTheme = writable(storedDarkTheme);
-export function toggleTheme() {
-    if (browser) {
-        darkTheme.update((mode) => {
-            const newMode = !mode;
-            localStorage.setItem('darkTheme', JSON.stringify(newMode));
-            return newMode;
-        });
-    }
-}

package/dist/utils/localpulls.d.ts

@@ -1,8 +0,0 @@
-export declare function allDocs(group: string): Promise<{
-    meta: any;
-    linkpath: string;
-}[]>;
-export declare function allDocsOrdered(): Promise<{
-    meta: any;
-    linkpath: string;
-}[]>;

package/dist/utils/localpulls.js

@@ -1,29 +0,0 @@
-export async function allDocs(group) {
-    const posts = import.meta.glob('/src/routes/docs/*.md');
-    const allfiles = { ...posts };
-    const filed = Object.entries(allfiles);
-    const eachfiled = await Promise.all(filed.map(async ([path, resolver]) => {
-        // @ts-expect-error//why
-        const { metadata } = await resolver();
-        const pathitem = path.slice(11, -3);
-        return {
-            meta: metadata,
-            linkpath: pathitem
-        };
-    }));
-    const validPosts = eachfiled.filter((post) => post !== null);
-    const groupedPosts = validPosts
-        .filter(post => post.meta?.group?.includes(group))
-        .sort((a, b) => Number(a.meta.id) - Number(b.meta.id));
-    return groupedPosts;
-}
-const GROUP_ORDER = ['getting started', 'customization', 'api-reference', 'guides-and-advanced', 'others'];
-export async function allDocsOrdered() {
-    const posts = import.meta.glob('/src/routes/docs/*.md');
-    const entries = await Promise.all(Object.entries(posts).map(async ([path, resolver]) => {
-        // @ts-expect-error untyped mdsvex metadata
-        const { metadata } = await resolver();
-        return { meta: metadata, linkpath: path.slice(11, -3) }; // "docs/introduction"
-    }));
-    return entries.sort((a, b) => Number(a.meta.id) - Number(b.meta.id));
-}