aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-03-09 13:25:37 -0800
committerGitHub <[email protected]>2021-03-09 13:25:37 -0800
commit336af3908ec78b7c72f00731671b6a6350ad32f3 (patch)
tree367e9b7241de3b810404c17525766084370c3490 /README.md
parentchore: upload screeny (diff)
downloadworldsy-336af3908ec78b7c72f00731671b6a6350ad32f3.tar.xz
worldsy-336af3908ec78b7c72f00731671b6a6350ad32f3.zip
chore: preview, usage info, roadmap.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7561c54..8546a96 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# worldsy
A Discord RPC client for [Worlds](http://worldsonline.com/).
+![](./assets/screenshot.png)
+
# Why?
Honestly, I was bored...
@@ -18,6 +20,11 @@ Plus, I'd bet there's more Python developers out there than just about any other
### How much time did you spend writing this?
Around three to four hours, without getting up, without looking away... I need help.
+# Usage
+1. Download the latest release from the [releases](https://github.com/fuwn/worldsy/releases/latest).
+2. Run executable.
+3. Click "Start RPC".
+
## Development
To get started with this project;
@@ -28,6 +35,10 @@ To build an executable, execute `build.bat`.
Note that this is only tested on Windows 10, there is no guarantee that this will work on other operating systems but be my guest in trying.
+## Roadmap
+- [Worldsy](https://github.com/fuwn/worldsy/projects/1)
+- [Worldsy (Rust Re-write)](https://github.com/fuwn/worldsy/projects/2)
+
## Notice
All rights go to Worlds.com for the images with the [/assets](./assets) directory.