diff --git a/.vuepress/config.js b/.vuepress/config.js index 9cbcfcc..f2a24a0 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -41,6 +41,7 @@ module.exports = { sidebarDepth: 3, sidebar: [ + '/lib/Installation', '/lib/WhyUsePromises', '/lib/Tour', '/lib/Examples', diff --git a/lib/Installation.md b/lib/Installation.md new file mode 100644 index 0000000..35c43f2 --- /dev/null +++ b/lib/Installation.md @@ -0,0 +1,34 @@ +--- +title: Installation +--- + +# Installation + +### Method 1 - Quick and Dirty + +1. Make sure HTTP requests are enabled in Game Settings +2. In Roblox Studio, select the folder where you keep your third party modules / utilities. +3. Run this in the command bar: + + + +### Method 2 - Manual + +1. Visit the [latest release](https://github.com/evaera/roblox-lua-promise/releases/latest) +2. Under *Assets*, click `Promise.lua` +3. - Using [Rojo](https://rojo.space/)? Put the file into your game directly. + - Using Roblox Studio? Open the file, copy its contents, and paste into a ModuleScript and call it `Promise`. + +### Method 3 - Git Submodule + +1. Add the Promise repository as a git submodule (ideally within a folder called `submodules`) (tutorial [here](https://gist.github.com/gitaarik/8735255)) +2. Update your [Rojo configuration](https://rojo.space/docs/6.x/project-format/) to point to the appropriate path and sync the file in. + +### Method 4 - Package Manager + +Using a package manager? The repository has a [`rotriever.toml`](https://github.com/evaera/roblox-lua-promise/blob/master/rotriever.toml). + + +## Next + +Now, check out the [API reference](/lib)! \ No newline at end of file