From ccc095891ad9bdb534dbf92bd8a3440fe94e5f43 Mon Sep 17 00:00:00 2001 From: eccenux Date: Sun, 25 Feb 2024 11:30:07 +0100 Subject: [PATCH] Quick install info --- README.md | 10 ++++++++-- package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8c8ae6b..8ad5790 100644 --- a/README.md +++ b/README.md @@ -44,14 +44,20 @@ Don't add this option to CSS though. It won't work correctly. ## Using Wikiploy +Either use [Wikiploy project template](https://github.com/Eccenux/wikiploy-rollout-example/releases) or add Wikiploy to your project: +``` +# npm install wikiploy --save-dev +npm i wikiploy -D +``` + 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 ;). -You do need to setup a bot password though (on [[Special:BotPasswords]]). It's not as hard as it might seem as **you can do this on *any* Wikimedia wiki and it will work for *all* WMF wikis**. You don't need a bot account for this to work. You will just create an alias for your stadnard account and special password just for your scripts. +You do need to setup a bot password though (on [[Special:BotPasswords]]). It's not as hard as it might seem as **you can do this on *any* Wikimedia wiki and it will work for *all* WMF wikis**. You don't need a bot account for this to work. You will just create an alias for your standard account and a special password just for your scripts. ## Botpass configuration A bot password is essentially a sub-account, designed to help keep your activities separated and secure. Setting up a sub-account is straightforward, and nearly anyone can do it. -1. Begin by setting up your sub-account on this page: [https://test.wikipedia.org/wiki/Special:BotPasswords](test.wikipedia.org/wiki/Special:BotPasswords). +1. Begin by setting up your sub-account on this page: [test.wikipedia.org/wiki/Special:BotPasswords](https://test.wikipedia.org/wiki/Special:BotPasswords). 2. Choose a name and specify the permissions for your sub-account. For instance, you should grant rights necessary for deploying gadgets (if applicable). You can refer to this example screenshot for setting up rights: [assets\Bot passwords - Test Wikipedia.png](https://github.com/Eccenux/Wikiploy/blob/main/assets/Bot%20passwords%20-%20Test%20Wikipedia.png). 3. Next, create your `bot.config.mjs` file. An example configuration file can be found here: `assets\public--bot.config.mjs`. diff --git a/package-lock.json b/package-lock.json index 117435c..935e859 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "wikiploy", - "version": "2.0.0", + "version": "2.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "wikiploy", - "version": "2.0.0", + "version": "2.0.1", "license": "MIT", "dependencies": { "mwn": "2.0.x" diff --git a/package.json b/package.json index 3816ced..1dfbe37 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wikiploy", - "version": "2.0.0", + "version": "2.0.1", "description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).", "main": "src/index.js", "type": "module",