Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cressie176 committed May 11, 2024
1 parent b41b198 commit 45c3e2a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# oubliette - a programmatic api for npm
# Oubliette - a programmatic api for npm

[![NPM version](https://img.shields.io/npm/v/oubliette.svg?style=flat-square)](https://www.npmjs.com/package/oubliette)
[![Node.js CI](https://github.com/acuminous/oubliette/workflows/Node.js%20CI/badge.svg)](https://github.com/acuminous/oubliette/actions?query=workflow%3A%22Node.js+CI%22)
Expand Down Expand Up @@ -29,7 +29,7 @@ Execute a [command](https://raw.githubusercontent.com/acuminous/oubliette/main/l
npm().install('express', 'pg', 'debug');
```

Execute [command](https://raw.githubusercontent.com/acuminous/oubliette/main/lib/commands.json) with short options
Execute [npm command](https://raw.githubusercontent.com/acuminous/oubliette/main/lib/commands.json) with short options
```js
npm().install('nodemon', { 'g': true });
```
Expand All @@ -47,7 +47,7 @@ npm().findDupes();
```

## Parsing Output
oubliette uses NodeJS [child_process.exec](https://nodejs.org/api/child_process.html#child_processexecsynccommand-options ) and [child_process.execAsync](https://nodejs.org/api/child_process.html#child_processexeccommand-options-callback) under the hood. These sometimes return stdout as a [Buffer](https://nodejs.org/api/buffer.html). oubliette converts this to a string by default;
Oubliette uses NodeJS [child_process.exec](https://nodejs.org/api/child_process.html#child_processexecsynccommand-options ) and [child_process.execAsync](https://nodejs.org/api/child_process.html#child_processexeccommand-options-callback) under the hood. These sometimes return stdout as a [Buffer](https://nodejs.org/api/buffer.html). Oubliette converts this to a string by default;

```js
const output = npm().view('express');
Expand Down Expand Up @@ -92,7 +92,7 @@ try {
```
The error will be decorated with `stdout` and `stderr` properties.

## Why "oubliette"?
## Why "Oubliette"?

According to [Wikipedia](https://en.wikipedia.org/wiki/Dungeon), an oubliette is a basement room or bottle dungeon which is accessible only from a hole in a high ceiling and therefore difficult to escape from. If you've ever descended into the [npm souce code](https://github.com/npm/cli/blob/latest/lib/commands) you will appreciate the similarity!

0 comments on commit 45c3e2a

Please sign in to comment.