Skip to content

Commit

Permalink
fix: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
VojtechVidra committed Jan 22, 2024
1 parent 37272a6 commit 6241296
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 9 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- A better way to onboard users and drive product adoption.

[![npm version](https://badge.fury.io/js/@rbnd%2Fflows.svg)](https://badge.fury.io/js/@rbnd%2Fflows)
[![npm version](https://badge.fury.io/js/@flows%2Fjs.svg)](https://badge.fury.io/js/@flows%2Fjs.svg)

## Examples

Expand All @@ -14,20 +14,20 @@
### NPM package

```bash
npm install @rbnd/flows
npm install @flows/js
```

### Via CDN

```html
<script src="https://cdn.jsdelivr.net/npm/@flows/js@0.0.30/dist/index.global.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@flows/js@0.0.30/css.min/flows.css" />
<script src="https://cdn.jsdelivr.net/npm/@flows/js@0.0.31/dist/index.global.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@flows/js@0.0.31/css.min/flows.css" />
```

### Usage

```js
import { init } from "@rbnd/flows"
import { init } from "@flows/js"

init({ flows: [ ... ] })

Expand Down
2 changes: 1 addition & 1 deletion examples/vanilla-js/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<!-- How you would use Flows in your own code -->
<!-- Make sure to lock specific version to avoid braking changes. See docs for more info. -->
<script src="https://cdn.jsdelivr.net/npm/@rbnd/flows/dist/index.global.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@flows/js/dist/index.global.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@flows/js/css.min/flows.css" />

<script src="index.js"></script>
Expand Down
27 changes: 24 additions & 3 deletions workspaces/js/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
{
"name": "@flows/js",
"description": "A better way to onboard users and drive product adoption.",
"version": "0.0.30",
"description": "Flows - SDK for building advanced user onboarding tours. Supports no-code or in-code flows. With advanced features like Wait or Conditional steps to create the ultimate onboarding tour, boosting product adoption. Optimize user journey, increase engagement, and enhance product experiences with Flows.",
"keywords": [
"react",
"javascript",
"html",
"ux",
"guide",
"spotlight",
"popover",
"overlay",
"users",
"vanilla-js",
"saas",
"onboarding",
"tour",
"walkthrough",
"user-onboarding",
"feature-introductions",
"onboarding-tool",
"product-adoption",
"product-tours"
],
"version": "0.0.31",
"repository": {
"type": "git",
"url": "git+https://github.com/RBND-studio/flows-js.git"
Expand Down Expand Up @@ -30,7 +51,7 @@
"test:watch": "jest --watch",
"lint": "eslint",
"tsc": "tsc -p tsconfig.json",
"release": "pnpm build && pnpm publish --access=public --no-git-checks"
"release": "cp ../../README.md . && pnpm build && pnpm publish --access=public --no-git-checks"
},
"dependencies": {
"@floating-ui/dom": "^1.5.3",
Expand Down

0 comments on commit 6241296

Please sign in to comment.