aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-03-20 15:46:12 +0000
committerFuwn <[email protected]>2021-03-20 15:46:12 +0000
commit2abd749036d29fc7452684fae85ab039186297d9 (patch)
tree24b450fe1c47b7d52234eecef49c50a7e6008e4b /README.md
parentfix: formatting (diff)
downloadwhirl-2abd749036d29fc7452684fae85ab039186297d9.tar.xz
whirl-2abd749036d29fc7452684fae85ab039186297d9.zip
whirl: :star:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5c302bc..c9db56b 100644
--- a/README.md
+++ b/README.md
@@ -24,10 +24,20 @@ Two *main* reasons;
TLDR: To keep Worlds' legacy going for future generations.
## Usage
-Work-in-progress.
+Use in production environments is not recommended as this project is a work-in-progress. As we begin to become more stable and add new features, we will release periodic updates regarding production use.
## Documentation
-Work-in-progress.
+[https://www.whirlsplash.org](https://www.whirlsplash.org)
+
+## Development
+1. Navigate to your `/etc/hosts` file, on Windows, this usually is located at `C:\Windows\System32\drivers\etc\hosts`.
+2. Add these rules;
+```
+0.0.0.0 www.3dcd.com
+0.0.0.0 test.3dcd.com
+```
+3. Build and run the Cargo project.
+4. Profit.
## Contributing
Work-in-progress.