From 3325eba7d8773df4c8efa2be7f220a32a938cfea Mon Sep 17 00:00:00 2001 From: adamant-al Date: Thu, 27 Mar 2025 16:28:13 +0300 Subject: [PATCH] chore: update Readme --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 176d6c1..b7d6288 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,43 @@ # ADAMANT Developers Handbook [![build status](https://img.shields.io/github/actions/workflow/status/Adamant-im/developers/github-pages.yaml?branch=master)](https://github.com/Adamant-im/developers/actions/workflows/github-pages.yaml) -Guide for setting up, contributing, and collaborating on the ADAMANT Messenger open-source project +Guide for setting up, contributing, and collaborating on the ADAMANT Messenger open-source project. -_https://developers.adamant.im_ +Auto-built website at GitHub Pages: _https://developers.adamant.im_. ## Bootstrap Install dependencies via `npm`: -``` -$ npm install +```shell +npm install ``` Then start dev server: ```shell -$ npm run dev +npm run dev ``` -You should now have the VitePress UI running at _http://localhost:5173_ +You should now have the VitePress UI running at _http://localhost:5173_. ## Commands -To build the docs run: +To build the docs, run: ```shell -$ npm run build +npm run build ``` Once the project is built you can preview `.vitepress/dist` by: ```shell -$ npm run preview +npm run preview ``` -The preview should be available at _http://localhost:4173_ +The preview should be available at _http://localhost:4173_. ## Links -- [ADAMANT Node API Spec Wiki](https://github.com/Adamant-im/adamant/wiki/API-Specification) -- [ADAMANT Messenger Repo](https://github.com/adamant-im/adamant-im) +- [ADAMANT Node API Specification](https://docs.adamant.im) +- [ADAMANT Messenger's Progressive Web Application Repo](https://github.com/adamant-im/adamant-im) - [VitePress Docs](https://vitepress.dev)