Changes

.gitignore

@@ -1,3 +1,4 @@
-out
-node_modules
-include
+out
+node_modules
+include
+**/*.ts-output

README.md

@@ -16,9 +16,29 @@ Transformer for Roblox TypeScript compiler that allows getting values of process
     }
 ```
 
-For example, you have a `.env` file in your project directory as following:
+# Usage
+## `$NODE_ENV`
+This will change to whatever the value of `NODE_ENV` is in your environment. If no value is set, this is defined in the configuration options above under `defaultEnvironment`, or `"production"` if no such value is present.
 
-```env
-HELLO=Hello, World!
-NUMBER=20
-```
+## `$env`
+This contains three functions of which can be used to obtain environment variables
+
+#### `$env.string( variable [, defaultValue] )`
+This will attempt to grab the given `variable` from the environment, otherwise will provide the default value. (`undefined` if no default value is given)
+
+#### `$env.boolean( variable )`
+This can be used to get a boolean environment variable, or check if an environment variable exists.
+If the value is not (case-insensitive) `false`, but is set it will be considered `true`. This can be used to also check if environment variables exist.
+
+#### `$env.number( variable [, defaultValue] )`
+This will attempt to grab the given `variable` from the environment and parse it as a number, otherwise will provide the default value. (`undefined` if no default value is given)
+
+# Behaviours
+If there is an if statement, an attempt will be made to short-circuit the if statement. e.g.
+
+```ts
+if ($NODE_ENV === "production") {
+    // Code here
+}
+```
+Any code in this if statement will not render (unless an else is specified) if the environment is not production. 

example/src/shared/module.ts

@@ -1,8 +1,8 @@
 import { $env, $NODE_ENV } from "../../..";
 
-$env("NODE_ENV");
+const test = $env.string("USERPROFILE");
 
-const test = $env.string("POOP");
+$env.string("test", "withDefault");
 
 function testing() {
 	if ($env.boolean("USERPROFILE")) {
@@ -17,7 +17,8 @@ $NODE_ENV;
 if ($NODE_ENV === "production") {}
 if ("public-test" === $NODE_ENV) {}
 
-if ($env.string("NODE_ENV") === "right") {}
-if ($env.string("NODE_ENV2")) {}
+if ($env.boolean("USERPROFILE")) {
+	const seqAddr = $env.string("USERPROFILE");
+}
 
 const something = $NODE_ENV === "production" ? "yes":"no";

index.d.ts

@@ -16,11 +16,6 @@
 export const $env: $env;
 
 export interface $env {
-	/** @deprecated Use `$env.string`, `$env.number` or `$env.boolean` */
-	(variable: string): string | undefined;
-	/** @deprecated Use `$env.string`, `$env.number` or `$env.boolean` */
-	(variable: string, defaultValue: string): string;
-
 	/**
 	 * Attempts to fetch the given environment variable - if not set, it will be `undefined` or the default value if given.
 	 * @param name The name of the variable