From 803a36133dc2e68662b16cea713eaa2ceaf2b924 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 12 May 2018 19:27:23 -0400 Subject: [PATCH] update docs (#253) --- docs/README.md | 12 ++++++++++-- docs/release-notes.md | 1 + 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3112c023..e7d6d682 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ **SMAPI** is an open-source 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 six main purposes: +change any of your game files. It serves eight 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 @@ -25,10 +25,18 @@ change any of your game files. It serves six 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.** +6. **Provide update checks.** _SMAPI automatically checks for new versions of your installed mods, and notifies you when any are available._ +7. **Provide compatibility checks.** + _SMAPI automatically detects outdated or broken code in mods, and safely disables them before + they cause problems._ + +8. **Back up your save files.** + _SMAPI automatically creates a daily backup of your saves and keeps ten backups, in case + something goes wrong. (Via the bundled SaveBackup mod.)_ + ## Documentation Have questions? Come [chat on Discord](https://discord.gg/KCJHWhX) with SMAPI developers and other modders! diff --git a/docs/release-notes.md b/docs/release-notes.md index ff9fcdac..b531d7ec 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,6 +2,7 @@ ## 2.6 beta * For players: * Updated for Stardew Valley 1.3 (no longer compatible with earlier versions). + * Added a bundled save backup mod. * Added beta update channel. * Added prompt when in beta channel and a new version is found. * Added friendly error when game can't start audio.