Skip to content

Update Readme #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)