From f7a71eeb880a39fcb4695e9d752fa79d1cfc3a73 Mon Sep 17 00:00:00 2001 From: Rakeden <5896201+rakeden@users.noreply.github.com> Date: Mon, 4 Mar 2024 02:16:39 +0100 Subject: [PATCH] update README.md --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cc053cff..2c61b420 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Welcome to WAX Developer Portal

+

WAX Developer Portal

@@ -16,22 +16,44 @@ ### [Visit Documentation](https://developer.wax.io/) -## Prerequisites +## Installation -- node >=16.19.0 +### Prerequisites +- Node.js version 18 or higher. +- Terminal for accessing VitePress via its command line interface (CLI). +- Text Editor with Markdown syntax support. +- VSCode is recommended, along with the official Vue extension. -## Install +VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with: ```sh npm install ``` -## Usage +## Up and Running + +The tool should have also injected the following npm scripts to your package.json if you allowed it to do so during the setup process: + +```json +{ + ... + "scripts": { + "docs:dev": "vitepress dev docs", + "docs:build": "vitepress build docs", + "docs:preview": "vitepress preview docs" + }, + ... +} +```` ```sh npm run docs:dev ``` +## What's Next? + +Read the [vitepress docs](https://vitepress.dev/guide/getting-started#what-s-next) + ## Contributing Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/wax-office-of-inspector-general/wax-developer/issues). You can also take a look at the [contributing guide](https://github.com/wax-office-of-inspector-general/wax-developer/wiki/2-Contribution-Guides).