From 7daadf408325252cdf9600f56c966b3e940bb5ae Mon Sep 17 00:00:00 2001
From: Benjamin Gruenbaum <benji@peer5.com>
Date: Sat, 14 Jul 2018 14:57:53 +0300
Subject: [PATCH] async await example

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c7be71a..1c72e89 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 A simple utility for creating temporary files or directories.
 
-The [tmp](https://github.com/raszi/node-tmp) package with promises support.
+The [tmp](https://github.com/raszi/node-tmp) package with promises support. If you want to use `tmp` with `async/await` then this helper might be for you.
 
 This documentation is mostly copied from that package's - but with promise usage instead of callback usage adapted.
 
@@ -29,6 +29,20 @@ tmp-promise also uses promise [disposers](http://stackoverflow.com/questions/289
 
 Simple temporary file creation, the file will be closed and unlinked on process exit.
 
+With Node.js 10 and es - modules:
+
+```js
+import { file } from 'tmp-promise'
+
+(async () => {
+  const {fd, path, cleanup} = await file();
+  // work with file here in fd
+  cleanup();
+})(); 
+```
+
+Or the older way:
+
 ```javascript
 var tmp = require('tmp-promise');
 
@@ -45,6 +59,19 @@ tmp.file().then(o => {
 
 Simple temporary file creation with a [disposer](http://stackoverflow.com/questions/28915677/what-is-the-promise-disposer-pattern):
 
+With Node.js 10 and es - modules:
+
+```js
+import { withFile } from 'tmp-promise'
+
+withFile(async ({path, fd}) => {
+  // when this function returns or throws - release the file 
+  await doSomethingWithFile(db);
+});
+```
+
+Or the older way:
+
 ```js
 tmp.withFile(o => {
   console.log("File: ", o.path);