Skip to content

Commit 80193e6

Browse files
authoredMay 2, 2024··
docs: update docs for repo rename (#2)
1 parent 53f2dd1 commit 80193e6

File tree

3 files changed

+20
-12
lines changed

3 files changed

+20
-12
lines changed
 

Diff for: ‎README.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Onify Script Functions
22

3-
[![Build latest](https://github.com/onify/script-functions/actions/workflows/build.yaml/badge.svg)](https://github.com/onify/script-functions/actions/workflows/build.yaml)
3+
[![Build latest](https://github.com/onify/flow-script-functions/actions/workflows/build.yaml/badge.svg)](https://github.com/onify/flow-script-functions/actions/workflows/build.yaml)
44

55
This library provides various functions for Node.js applications.\
66
The functions available are as follows:
@@ -12,27 +12,35 @@ The functions available are as follows:
1212
## Installation
1313

1414
```
15-
npm install @onify/script-functions
15+
npm install @onify/flow-script-functions
1616
```
1717

1818
## Usage
1919

20+
### Use in Onify Flow:
21+
Use `functions.*` to access the functions present in this library.
22+
23+
```js
24+
const result = functions.slugify('sample onify');
25+
console.log(result); // output: sample-onify
26+
```
27+
2028
### Import the library:
2129

2230
##### Javascript
2331

2432
```js
25-
const functions = require('@onify/script-functions');
33+
const functions = require('@onify/flow-script-functions');
2634
```
2735

2836
##### Typescript
2937

3038
```ts
3139
// import all functions
32-
import * as functions from '@onify/script-functions';
40+
import * as functions from '@onify/flow-script-functions';
3341
// or
3442
// import specific functions
35-
import { slugify } from '@onify/script-functions';
43+
import { slugify } from '@onify/flow-script-functions';
3644
```
3745

3846
### Use the functions:
@@ -62,7 +70,7 @@ GUID string with the format `${string}-${string}-${string}-${string}-${string}`
6270
### Example
6371

6472
```ts
65-
import { generateUuid } from '@onify/script-functions';
73+
import { generateUuid } from '@onify/flow-script-functions';
6674

6775
// ...
6876
const id = generateUuid(); // generates random GUID
@@ -92,7 +100,7 @@ slugify(text: string): string
92100
### Example
93101

94102
```ts
95-
import { slugify } from '@onify/script-functions';
103+
import { slugify } from '@onify/flow-script-functions';
96104

97105
// ...
98106
const transformedText = slugify('Hello World!');
@@ -122,7 +130,7 @@ validateEmail(email: string): boolean
122130
### Example
123131

124132
```ts
125-
import { validateEmail } from '@onify/script-functions';
133+
import { validateEmail } from '@onify/flow-script-functions';
126134

127135
// ...
128136
const isValid = slugify('sample@onify.co');

Diff for: ‎package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@onify/script-functions",
2+
"name": "@onify/flow-script-functions",
33
"version": "1.0.2",
44
"description": "Onify Script Functions",
55
"main": "dist/index.js",
@@ -36,7 +36,7 @@
3636
},
3737
"repository": {
3838
"type": "git",
39-
"url": "git+https://github.com/onify/script-functions.git"
39+
"url": "git+https://github.com/onify/flow-script-functions.git"
4040
},
4141
"files": [
4242
"dist"

0 commit comments

Comments
 (0)
Please sign in to comment.