docuseal-svelte 0.0.1 → 0.0.2
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 +16 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,58 +1,28 @@
|
|
|
1
|
-
# Svelte
|
|
1
|
+
# DocuSeal Svelte
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A SvelteKit component library for integrating DocuSeal electronic signatures into your Svelte applications.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
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
|
|
7
|
+
```bash
|
|
8
|
+
npm install docuseal-svelte
|
|
17
9
|
```
|
|
18
10
|
|
|
19
|
-
##
|
|
20
|
-
|
|
21
|
-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
|
11
|
+
## Usage
|
|
22
12
|
|
|
23
|
-
```
|
|
24
|
-
|
|
13
|
+
```svelte
|
|
14
|
+
<script lang="ts">
|
|
15
|
+
import { DocuSealForm, DocuSealFormBuilder } from 'docuseal-svelte';
|
|
16
|
+
</script>
|
|
25
17
|
|
|
26
|
-
|
|
27
|
-
|
|
18
|
+
<DocuSealForm src="<YOUR_DOCUSEAL_FORM_SRC>" />
|
|
19
|
+
<DocuSealFormBuilder src="<YOUR_DOCUSEAL_FORM_SRC>" token="<YOUR_DOCUSEAL_TOKEN>" />
|
|
28
20
|
```
|
|
29
21
|
|
|
30
|
-
|
|
22
|
+
## How to Contribute
|
|
31
23
|
|
|
32
|
-
|
|
24
|
+
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.
|
|
33
25
|
|
|
34
|
-
|
|
26
|
+
## License
|
|
35
27
|
|
|
36
|
-
|
|
37
|
-
npm pack
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
To create a production version of your showcase app:
|
|
41
|
-
|
|
42
|
-
```sh
|
|
43
|
-
npm run build
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
You can preview the production build with `npm run preview`.
|
|
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
|
-
```sh
|
|
57
|
-
npm publish
|
|
58
|
-
```
|
|
28
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|