Skip to content

Commit

Permalink
docs(scoped): scoped package
Browse files Browse the repository at this point in the history
  • Loading branch information
kishor82 committed Apr 29, 2024
1 parent bec6b44 commit b9ad06d
Show file tree
Hide file tree
Showing 3 changed files with 371 additions and 516 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![NPM Version](https://img.shields.io/npm/v/jsonflat)](https://www.npmjs.com/package/jsonflat)
[![NPM Version](https://img.shields.io/npm/v/@kishor82/jsonflat)](https://www.npmjs.com/package/@kishor82/jsonflat)
[![Build status](https://img.shields.io/github/actions/workflow/status/kishor82/jsonflat/unit-tests-cli.yml)](https://github.com/kishor82/jsonflat/actions/workflows/unit-tests-cli.yml)
[![Coverage Status](https://coveralls.io/repos/github/kishor82/jsonflat/badge.svg)](https://coveralls.io/github/kishor82/jsonflat)

Expand All @@ -13,15 +13,15 @@
You can install `jsonflat` via npm:

```bash
npm install jsonflat
npm install @kishor82/jsonflat
```

## Usage

To flata nested JSON object, import the `flat` function from `jsonflat` and use it as follows:

```javascript
const { flat } = require("jsonflat");
const { flat } = require("@kishor82/jsonflat");

const nestedObject = {
person: {
Expand Down Expand Up @@ -66,7 +66,7 @@ Returns: A new object with flattened keys.
### flatNested JSON Object

```javascript
const { flat } = require("jsonflat");
const { flat } = require("@kishor82/jsonflat");

const nestedObject = {
person: {
Expand Down

0 comments on commit b9ad06d

Please sign in to comment.