diff --git a/README.md b/README.md new file mode 100644 index 0000000..16d23c6 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# An async wrapper for nodejs' `spawn` + +```typescript +import spawn from "async-spawner"; +await simpleSpawn("ls", "-al"); +``` + +```typescript +import { deferedSpawn } from "async-spawner"; +const ping = await deferedSpawn("ping", ["8.8.8.8"]); +let response; +do{ + response = await ping.waitForNextData(); + console.log("new ping!", response); +} +ping.kill(); +```