Skip to content

Commit

Permalink
feat: update readme, bump @0.0.39
Browse files Browse the repository at this point in the history
  • Loading branch information
VojtechVidra committed Feb 23, 2024
1 parent 7f83a5a commit d271be8
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 132 deletions.
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.
54 changes: 24 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,34 @@
# Flows JS - Onboarding for modern SaaS
<p align="center">
<img src="https://flows.sh/images/logo/logo.svg" height="96">
<h1 align="center">Flows</h1>
</p>

- A better way to onboard users and drive product adoption.
<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?style=for-the-badge">
</a>
<a href="https://www.npmjs.com/package/@flows/js">
<img src="https://img.shields.io/npm/dt/%40flows%2Fjs?style=for-the-badge&logo=npm" alt="NPM Downloads" />
</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?style=for-the-badge">
</a>
</p>

[![npm version](https://badge.fury.io/js/@flows%2Fjs.svg)](https://badge.fury.io/js/@flows%2Fjs.svg)
<p align="center">
<strong>Onboarding for modern SaaS - A better way to onboard users and drive product adoption.</strong>
</p>

## Examples
## Getting started

- [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))
<!-- To learn how to use Flows visit [Docs](https://flows.sh/docs). -->

## Getting Started
Visit [https://flows.sh/docs](https://flows.sh/docs) to get started with Flows.

### NPM package
## What is Flows?

```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: [ ... ] })
```
Visit [Flows website](https://flows.sh) to learn more.

---

Created by [rbnd.studio](https://rbnd.studio/).
[Flows.sh](https://flows.sh) created by [rbnd.studio](https://rbnd.studio).
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

0 comments on commit d271be8

Please sign in to comment.