Skip to content

Commit

Permalink
Update README.md (#12)
Browse files Browse the repository at this point in the history
* Update README.md

* Update useage
  • Loading branch information
AkhilXavier95 authored Oct 31, 2023
1 parent 90aa83a commit b19a6a6
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,16 @@ Install the peer dependencies:
yarn add ramda
```


## List of Pure Functions

<table>
<thead>
<tr>
<th>

Name

</th>
<th>

Category

</th>
</tr>
</thead>
Expand Down Expand Up @@ -81,11 +79,6 @@ Category
- [isNot (alias notEquals)](./docs/pure/general.md#isnot_alias_notequals)
- [isNotEqualDeep (alias notEqualsDeep)](./docs/pure/general.md#isnotequaldeep_alias_notequalsdeep)

</td>
<td style="vertical-align: top;">

[Pure utility functions](./docs/pure/README.md)

</td>
</tr>

Expand All @@ -103,10 +96,23 @@ yarn add "@bigbinary/neeto-cist@latest"

## Usage

This package exports five different sets of functions and components. Click on
them to read more:
You can import all functions from `@bigbinary/neeto-cist`.

```js
import { slugify } from "@bigbinary/neeto-cist";
```

Exports several general utility functions that are used throughout neeto
products. The functions are designed in a similar fashion as ramda so that they
can easily interoperate with each other.

Pure functions were designed to be fail fast. If you call `findById(10, null)`,
it will throw error saying that it can't iterate through `null`.

3. [Pure utility functions](./docs/pure/README.md)
But for most such pure functions, there is a failsafe alternative available. The
failsafe alternative function will be prefixed with `_`. Example:
`_findById(10, null)` returns `null`, `_findById(10, undefined)` returns
`undefined` and `_findById(10, [{ id: 10 }])` returns `{ id: 10 }`.

## Other references

Expand Down

0 comments on commit b19a6a6

Please sign in to comment.