From 5d6c784e6de54c1f54bf53c1afbe63ca21f2204e Mon Sep 17 00:00:00 2001 From: Eryn Lynn Date: Tue, 10 Sep 2019 15:41:59 -0400 Subject: [PATCH] Update readme --- .vuepress/.gitignore | 1 + README.md | 9 +-------- 2 files changed, 2 insertions(+), 8 deletions(-) create mode 100644 .vuepress/.gitignore diff --git a/.vuepress/.gitignore b/.vuepress/.gitignore new file mode 100644 index 0000000..7773828 --- /dev/null +++ b/.vuepress/.gitignore @@ -0,0 +1 @@ +dist/ \ No newline at end of file diff --git a/README.md b/README.md index fa39f85..45d4ac1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,3 @@ ---- -home: true -actionText: API docs → -actionLink: /lib/ -footer: MIT Licensed ---- - # Roblox Lua Promise An implementation of `Promise` similar to Promise/A+. @@ -26,7 +19,7 @@ This Promise implementation attempts to satisfy these traits: * Predictable timing ## Example -This Promise implementation finished synchronously. In order to wrap an existing async API, you should use `spawn` or `delay` in order to prevent your calling thread from accidentally yielding. +This Promise implementation finished synchronously. In order to wrap an existing async API, you should use `Promise.spawn` in order to prevent your calling thread from accidentally yielding. ```lua local HttpService = game:GetService("HttpService")