From 4d78cd9c27ca176b4ccff82756c8eb6a3048921b Mon Sep 17 00:00:00 2001 From: Scott Date: Tue, 1 Aug 2017 13:35:22 +1000 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d2be99b..b28efd4f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# modworksSDK -SDK powering mod.works a UGC marketplace for game developers +# mod.works SDK +Welcome to the [mod.works](https://mod.works) SDK, built using ???. It's purpose is to allow game developers to support the automatic installation of mods in their games. + +## Documentation +We use slate for [our documentation](https://sdk.mod.works), you can contribute and edit the documention the repository can be [found here](https://github.com/DBolical/modworksSDKDOCS). You are welcome to contribute. + +## Web +Consult our private [Web Repository](https://github.com/DBolical/modworksWEB) for the web frontend built that has basic management and setup functionality built in. + +## API +Consult our private [API Repository](https://github.com/DBolical/modworksAPI) for the API developers connect to, to manage their users mod collection. [Documentation](https://docs.mod.works) can be found here [(repo)](ttps://github.com/DBolical/modworksAPIDOCS). + +## Design +Consult our public [Design Repository](https://github.com/DBolical/modworksDESIGN) for the design we apply to our community frontend (the website).