Skip to content

Commit

Permalink
Add 'Requirements' section to every README
Browse files Browse the repository at this point in the history
  • Loading branch information
KSXGitHub committed Jun 13, 2018
1 parent 8aa7e62 commit fd3a232
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/typescript/ancestor-directories/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Iterate over all parent directories of a given path

## Requirements

* Node.js ≥ 8.9.0

## APIs

### Function Signature
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/extra-jest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Some extra functions to work with jest testing framework

## Requirements

* Node.js ≥ 8.9.0

## APIs

**NOTE:**
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/fs-tree-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Work with filesystem tree with ease

## Requirements

* Node.js ≥ 8.9.0

## APIs

**NOTE:**
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/monorepo-shared-assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This packages contains types and functions that are used by [nodemonorepo](https://git.io/vhoXX).

## Requirements

* Node.js ≥ 8.9.0

## License

[MIT](https://git.io/vhaEz) © [Hoàng Văn Khải](https://github.com/KSXGitHub)
4 changes: 4 additions & 0 deletions packages/typescript/monorepo-shared-yaml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Just [js-yaml](https://git.io/5UpxBw) + [some extra methods](additional-apis)

## Requirements

* Node.js ≥ 8.9.0

## Additional APIs

* `yaml.yaml`: exported object of `js-yaml`.
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/nested-workspace-helper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Some commands in needs for nodemonorepo

## Requirements

* Node.js ≥ 8.9.0

## CLIs

This program is divided into multiple subcommands which print usage messages when issued without arguments.
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/restricted-concurrent-actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Like `Promise.all`, but limit number of concurrent promises

## Requirements

* Node.js ≥ 8.9.0

## Usage

### Function Signature
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/restricted-parallel-processes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Spawn all processes, but limit number of parallel processes

## Requirements

* Node.js ≥ 8.9.0

## Usage Example

Spawn 4 commands at a time.
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/sh-or-cmd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Returns `'sh'` in UNIX/Linux and `'cmd'` in Windows.

## Requirements

* Node.js ≥ 8.9.0

## Usage

```javascript
Expand Down
4 changes: 4 additions & 0 deletions packages/typescript/unique-temp-path/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Create temporary directory/file names that are unique

## Requirements

* Node.js ≥ 8.9.0

## Why?

There're always files/directories being added to temporary directory. There's a chance, albeit rather small, that a random string would collapse with them. For this reason, it is necessary to check whether that random name exists.
Expand Down

0 comments on commit fd3a232

Please sign in to comment.