Skip to content

Commit 2e6a172

Browse files
committed
Updated README, updated dependencies
1 parent ed37ced commit 2e6a172

File tree

2 files changed

+567
-530
lines changed

2 files changed

+567
-530
lines changed

README.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,30 @@
1-
# Website
1+
# Boa Website
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
This is the website for the Boa project, a JavaScript engine written in Rust. The website provides documentation, tutorials, and other resources for users and contributors.
4+
You can find it at [boajs.dev](https://boajs.dev).
5+
6+
## Contributing
7+
8+
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
49

510
### Installation
611

712
```
8-
$ npm
13+
$ npm install
914
```
1015

1116
### Local Development
1217

1318
```
14-
$ npm start
19+
$ npm run start
1520
```
1621

1722
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1823

1924
### Build
2025

2126
```
22-
$ npm build
27+
$ npm run build
2328
```
2429

2530
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true npm run deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> npm run deploy
39-
```
40-
41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

0 commit comments

Comments
 (0)