Skip to content

Commit

Permalink
docs: update readme (#44)
Browse files Browse the repository at this point in the history
issues:
* docs: update readme (#43)

commits:
* docs: update readme (f9a1a36)
  • Loading branch information
mnrendra committed Jun 18, 2024
1 parent 99d1816 commit 827438a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@ console.log('synchronously:', name, version) // Output: synchronously: project-n
import { readPackage } from '@mnrendra/read-package'

// Asynchronously
readPackage().then(({ name, version }) => {
console.log('asynchronously:', name, version) // Output: asynchronously: project-name 1.0.0
})
readPackage()
.then(({ name, version }) => {
console.log('asynchronously:', name, version) // Output: asynchronously: project-name 1.0.0
})
```

#### 2. Read the `package.json` file in your published module:
Expand Down Expand Up @@ -99,9 +100,10 @@ console.log('synchronously:', name, version); // Output: synchronously: module-n
const { readPackage } = require('@mnrendra/read-package');

// Asynchronously
readPackage().then(({ name, version }) => {
console.log('asynchronously:', name, version); // Output: asynchronously: module-name 1.0.0
});
readPackage()
.then(({ name, version }) => {
console.log('asynchronously:', name, version); // Output: asynchronously: module-name 1.0.0
});
```

# Types
Expand All @@ -115,7 +117,7 @@ import type {
### [Options](https://github.com/mnrendra/read-package/blob/main/src/types/Options.ts)

## License
[MIT](https://github.com/mnrendra/read-packag/blob/HEAD/LICENSE)
[MIT](https://github.com/mnrendra/read-package/blob/HEAD/LICENSE)

## Author
[@mnrendra](https://github.com/mnrendra)

0 comments on commit 827438a

Please sign in to comment.