diff options
| author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2017-10-07 23:18:06 -0400 |
|---|---|---|
| committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2017-10-07 23:18:06 -0400 |
| commit | a0fc392002b98ffe803d48be70cd272e22706194 (patch) | |
| tree | e097351ec7cbf407b72045f13de40fc1951e8be4 /docs/README.md | |
| parent | a050dcede6a32213665922aefefbc1565ffdf06d (diff) | |
| download | SMAPI-a0fc392002b98ffe803d48be70cd272e22706194.tar.gz SMAPI-a0fc392002b98ffe803d48be70cd272e22706194.tar.bz2 SMAPI-a0fc392002b98ffe803d48be70cd272e22706194.zip | |
update readme
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 20 |
1 files changed, 6 insertions, 14 deletions
diff --git a/docs/README.md b/docs/README.md index 37aa50fe..2adf2bf0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,21 +1,9 @@  -## Contents -* [What is SMAPI?](#what-is-smapi) -* **[For players](#for-players)** -* **[For mod developers](#for-mod-developers)** -* [For SMAPI developers](#for-smapi-developers) - * [Compiling from source](#compiling-from-source) - * [Debugging a local build](#debugging-a-local-build) - * [Preparing a release](#preparing-a-release) -* [Advanced usage](#advanced-usage) - * [Configuration file](#configuration-file) - * [Command-line arguments](#command-line-arguments) - ## What is SMAPI? -**SMAPI** is an [open-source](LICENSE) modding API for [Stardew Valley](http://stardewvalley.net/) +**SMAPI** is an [open-source](LICENSE.md) modding API for [Stardew Valley](http://stardewvalley.net/) that lets you play the game with mods. It's safely installed alongside the game's executable, and -doesn't change any of your game files. It serves five main purposes: +doesn't change any of your game files. It serves six main purposes: 1. **Load mods into the game.** _SMAPI loads mods when the game is starting up so they can interact with it. (Code mods aren't @@ -40,6 +28,10 @@ doesn't change any of your game files. It serves five main purposes: crashing the game, and makes it possible to troubleshoot errors in the game itself that would otherwise show a generic 'program has stopped working' type of message._ +6. **Provide update checks.** + _SMAPI automatically checks for new versions of your installed mods, and notifies you when any + are available._ + ## Documentation * [For players & mod creators](http://stardewvalleywiki.com/Modding:Index) * [Release notes](release-notes.md) |