diff --git a/README.md b/README.md index ecb33d4..8c8ae6b 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,12 @@ The only change is that you need to provide bot configuration to Wikiploy (as al `WikiployLite` is now synonymous with `Wikiploy`. You can use either of the class names. +### userPrompt (v1.8) + +Use the `userPrompt` helper function to prompt for a summary in your Wikiploy script. This is only a helper. You can still set up a static summary, but a prompt helps to ensure you don't forget to change the summary. + +Note that when using `userPrompt` you have to use an interactive terminal. This might be a bit more tricky to set up but can still function as a one-click build from a commandbar (see [README: building your project](https://github.com/Eccenux/Wikiploy/blob/main/README.building%20your%20project.md)). + ### nowiki (v1.7) The `nowiki` property is a new option in `DeployConfig` since Wikiploy v1.7. It is now recommended to use `nowiki: true` for all JS files. @@ -36,12 +42,6 @@ JavaScript page is still a wiki page... Kind of. It can be added to a category o Don't add this option to CSS though. It won't work correctly. -### userPrompt (v1.8) - -Use the `userPrompt` helper function to prompt for a summary in your Wikiploy script. This is only a helper. You can still set up a static summary, but a prompt helps to ensure you don't forget to change the summary. - -Note that when using `userPrompt` you have to use an interactive terminal. This might be a bit more tricky to set up but can still function as a one-click build from a commandbar (see [README: building your project](https://github.com/Eccenux/Wikiploy/blob/main/README.building%20your%20project.md)). - ## Using Wikiploy The `Wikiploy` class can be used to help deploy scripts. It is using a bot API to do that, but don't worry, you don't need to be a bot ;).