Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Nov 26, 2024
1 parent 2c8d761 commit 7ba6ebc
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# 🌈 [nypm](https://www.youtube.com/watch?v=QH2-TGUlwu4)

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions][github-actions-src]][github-actions-href]
[![Codecov][codecov-src]][codecov-href]
<!-- automd:badges codecov -->

> Unified Package Manager for Node.js and Bun
[![npm version](https://img.shields.io/npm/v/nypm)](https://npmjs.com/package/nypm)
[![npm downloads](https://img.shields.io/npm/dm/nypm)](https://npm.chart.dev/nypm)
[![codecov](https://img.shields.io/codecov/c/gh/unjs/nypm)](https://codecov.io/gh/unjs/nypm)

<!-- /automd -->

Unified Package Manager for Node.js (npm, pnpm, yarn), Bun and Deno

## What does **nypm** do?

Expand Down Expand Up @@ -45,11 +48,11 @@ npx nypm remove defu

Install package:

<!-- AUTOMD_START generator="pm-install" name="nypm" -->
<!-- automd:pm-i -->

```sh
# ✨ Auto-detect
npx nypm i nypm
npx nypm install nypm

# npm
npm install nypm
Expand All @@ -62,9 +65,12 @@ pnpm install nypm

# bun
bun install nypm

# deno
deno install nypm
```

<!-- AUTOMD_END -->
<!-- /automd -->

Import:

Expand All @@ -76,8 +82,6 @@ import { addDependency } from "nypm";
const { addDependency } = require("nypm");
```

<!-- AUTOMD_START generator="jsdocs" -->

### `addDependency(name, options)`

Adds dependency to the project.
Expand Down Expand Up @@ -105,8 +109,6 @@ Installs project dependencies.

Removes dependency from the project.

<!-- AUTOMD_END -->

## 💻 Development

- Clone this repository
Expand Down

0 comments on commit 7ba6ebc

Please sign in to comment.