docuseal-svelte 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,58 +1,35 @@
1
- # Svelte library
1
+ # DocuSeal Svelte
2
2
 
3
- Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
3
+ A Svelte component library for integrating DocuSeal electronic signatures into your Svelte applications.
4
4
 
5
- Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
5
+ ## Installation
6
6
 
7
- ## Creating a project
8
-
9
- If you're seeing this, you've probably already done this step. Congrats!
10
-
11
- ```sh
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
17
- ```
18
-
19
- ## Developing
20
-
21
- Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
22
-
23
- ```sh
24
- npm run dev
25
-
26
- # or start the server and open the app in a new browser tab
27
- npm run dev -- --open
7
+ ```bash
8
+ npm install docuseal-svelte
28
9
  ```
29
10
 
30
- Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
31
-
32
- ## Building
11
+ ## Usage
33
12
 
34
- To build your library:
13
+ ```svelte
14
+ <script lang="ts">
15
+ import { DocuSealForm, DocuSealFormBuilder } from 'docuseal-svelte';
16
+ </script>
35
17
 
36
- ```sh
37
- npm pack
18
+ <DocuSealForm src="<YOUR_DOCUSEAL_FORM_SRC>" />
19
+ <DocuSealFormBuilder src="<YOUR_DOCUSEAL_FORM_SRC>" token="<YOUR_DOCUSEAL_TOKEN>" />
38
20
  ```
39
21
 
40
- To create a production version of your showcase app:
22
+ ## Compatibility
41
23
 
42
- ```sh
43
- npm run build
44
- ```
45
-
46
- You can preview the production build with `npm run preview`.
24
+ This package supports:
47
25
 
48
- > To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
26
+ - Svelte 4.x
27
+ - Svelte 5.x
49
28
 
50
- ## Publishing
29
+ ## How to Contribute
51
30
 
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/)).
31
+ Contributions are welcome! Please fork the repository and create a pull request with your changes. Make sure to create a changeset for any significant updates.
53
32
 
54
- To publish your library to [npm](https://www.npmjs.com):
33
+ ## License
55
34
 
56
- ```sh
57
- npm publish
58
- ```
35
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
@@ -1,4 +1,3 @@
1
- // src/lib/utils/docuseal.ts
2
1
  /**
3
2
  * Validates if a URL is a valid DocuSeal URL
4
3
  */
package/package.json CHANGED
@@ -1,6 +1,12 @@
1
1
  {
2
2
  "name": "docuseal-svelte",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
+ "description": "Docuseal Svelte component library for document signing and management.",
5
+ "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/SirCen/docuseal-svelte.git"
9
+ },
4
10
  "scripts": {
5
11
  "dev": "vite dev",
6
12
  "build": "vite build && npm run prepack",
@@ -8,8 +14,7 @@
8
14
  "prepare": "svelte-kit sync || echo ''",
9
15
  "prepack": "svelte-kit sync && svelte-package && publint",
10
16
  "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
11
- "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
12
- "release": "npm run build && changeset publish"
17
+ "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
13
18
  },
14
19
  "files": [
15
20
  "dist",
@@ -29,7 +34,7 @@
29
34
  }
30
35
  },
31
36
  "peerDependencies": {
32
- "svelte": "^5.0.0"
37
+ "svelte": "^4.0.0 || ^5.0.0"
33
38
  },
34
39
  "devDependencies": {
35
40
  "@changesets/cli": "^2.29.8",