Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update readme, bump @0.0.39 #23

Merged
merged 3 commits into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Flows

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
71 changes: 35 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,38 @@
# Flows JS - Onboarding for modern SaaS

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

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

## Examples

- [Javascript](https://github.com/RBND-studio/flows-js/tree/main/examples/vanilla-js) ([Demo](https://vanilla.flows.sh))
- [React](https://github.com/RBND-studio/flows-js/tree/main/examples/react-nextjs) ([Demo](http://react-nextjs.flows.sh))

## Getting Started

### NPM package

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

### Via CDN

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

### Usage

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

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

// or CDN
window.FlowsJS?.init({ flows: [ ... ] })
```
<p align="center">
<img src="https://flows.sh/images/logo/logo.svg" height="80">
<h1 align="center">Flows JS Library</h1>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/@flows/js">
<img alt="NPM Version" src="https://img.shields.io/npm/v/%40flows%2Fjs">
</a>
<a href="https://www.npmjs.com/package/@flows/js">
<img alt="NPM Downloads" src="https://img.shields.io/npm/dt/%40flows%2Fjs">
</a>
<a href="https://github.com/RBND-studio/flows-js">
<img alt="GitHub License" src="https://img.shields.io/github/license/RBND-studio/flows-js">
</a>
<a href="https://flows.sh/join-slack">
<img alt="Static Badge" src="https://img.shields.io/badge/Join_the_community-grey?logo=slack"">
</a>

</p>

## Getting started

User onboarding for modern SaaS - Flows lets you build any onboarding you want. Guide users, increase feature adoption, and improve revenue.

- Create flows with a WYSIWYG editor or define them in your codebase
- With Flows Cloud you can create and update flows on the fly without having to redeploy your app
- Automatically track the performance of your flows
- Use advanced step types like wait and conditional
- Customize anything with CSS and JS

Visit our [website](https://flows.sh) to learn more about Flows

## Documentation

Visit [https://flows.sh/docs](https://flows.sh/docs) for full documentation.

---

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"prepare": "husky install"
},
"devDependencies": {
"@commitlint/cli": "^18.4.3",
"@commitlint/cli": "^18.6.1",
"@commitlint/config-conventional": "^18.6.2",
"@vercel/style-guide": "^5.2.0",
"concurrently": "^8.2.2",
Expand Down
Loading
Loading