Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed May 12, 2020
1 parent 96ebc2e commit 541a2b2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 11 deletions.
2 changes: 1 addition & 1 deletion license
@@ -1,6 +1,6 @@
MIT License

Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
9 changes: 5 additions & 4 deletions package.json
Expand Up @@ -4,10 +4,11 @@
"description": "Get stdin as a string or buffer",
"license": "MIT",
"repository": "sindresorhus/get-stdin",
"funding": "https://github.com/sponsors/sindresorhus",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
"url": "https://sindresorhus.com"
},
"engines": {
"node": ">=10"
Expand All @@ -30,10 +31,10 @@
"read"
],
"devDependencies": {
"@types/node": "^11.13.4",
"ava": "^1.4.1",
"@types/node": "^13.13.5",
"ava": "^2.4.0",
"delay": "^4.2.0",
"tsd": "^0.7.2",
"tsd": "^0.11.0",
"xo": "^0.24.0"
}
}
7 changes: 1 addition & 6 deletions readme.md
@@ -1,15 +1,13 @@
# get-stdin [![Build Status](https://travis-ci.org/sindresorhus/get-stdin.svg?branch=master)](https://travis-ci.org/sindresorhus/get-stdin)
# get-stdin [![Build Status](https://travis-ci.com/sindresorhus/get-stdin.svg?branch=master)](https://travis-ci.com/sindresorhus/get-stdin)

> Get [stdin](https://nodejs.org/api/process.html#process_process_stdin) as a string or buffer

## Install

```
$ npm install get-stdin
```


## Usage

```js
Expand All @@ -27,7 +25,6 @@ $ echo unicorns | node example.js
unicorns
```


## API

Both methods returns a promise that is resolved when the `end` event fires on the `stdin` stream, indicating that there is no more data to be read.
Expand All @@ -44,12 +41,10 @@ Get `stdin` as a `Buffer`.

In a TTY context, a promise that resolves to an empty `Buffer` is returned.


## Related

- [get-stream](https://github.com/sindresorhus/get-stream) - Get a stream as a string or buffer


---

<div align="center">
Expand Down

0 comments on commit 541a2b2

Please sign in to comment.