Skip to content

Commit e8d4e27

Browse files
authored
Merge pull request #4 from devigned/fix-readme
fix: update readme to better reflect the project
2 parents 735e7d3 + b36e4ed commit e8d4e27

1 file changed

Lines changed: 31 additions & 33 deletions

File tree

README.md

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,48 @@
1+
# Hyperlight Website
12

2-
# Starlight Starter Kit: Basics
3+
The official website for [Hyperlight](https://github.com/hyperlight-dev/hyperlight), hosted at [hyperlight.org](https://hyperlight.org). Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications, enabling safe execution of untrusted code within micro virtual machines with very low latency and minimal overhead.
34

4-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
5+
Hyperlight is a [Cloud Native Computing Foundation](https://www.cncf.io/) sandbox project.
56

6-
```
7-
npm create astro@latest -- --template starlight
8-
```
7+
## Getting Started
98

10-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
9+
This site is built with [Astro](https://astro.build/) and the [Starlight](https://starlight.astro.build/) documentation theme.
1110

12-
## 🚀 Project Structure
11+
### Prerequisites
1312

14-
Inside of your Astro + Starlight project, you'll see the following folders and files:
13+
- [Node.js](https://nodejs.org/) v18 or later
1514

15+
### Local Development
16+
17+
```sh
18+
npm install
19+
npm run dev
1620
```
17-
.
18-
├── public/
19-
├── src/
20-
│ ├── assets/
21-
│ ├── content/
22-
│ │ └── docs/
23-
│ └── content.config.ts
24-
├── astro.config.mjs
25-
├── package.json
26-
└── tsconfig.json
21+
22+
The site will be available at `http://localhost:4321`.
23+
24+
### Build
25+
26+
```sh
27+
npm run build
2728
```
2829

29-
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
30+
The production build is output to `./dist/`.
31+
32+
## Contributing
3033

31-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
34+
We welcome contributions from everyone! Whether it's fixing a typo, improving documentation, or adding new content, your help is appreciated.
3235

33-
Static assets, like favicons, can be placed in the `public/` directory.
36+
1. Fork the repository
37+
2. Create a branch for your changes
38+
3. Submit a pull request
3439

35-
## 🧞 Commands
40+
Please review the [Hyperlight contributing guidelines](https://github.com/hyperlight-dev/hyperlight/blob/main/CONTRIBUTING.md) before getting started.
3641

37-
All commands are run from the root of the project, from a terminal:
42+
## Code of Conduct
3843

39-
| Command | Action |
40-
| :------------------------ | :----------------------------------------------- |
41-
| `npm install` | Installs dependencies |
42-
| `npm run dev` | Starts local dev server at `localhost:4321` |
43-
| `npm run build` | Build your production site to `./dist/` |
44-
| `npm run preview` | Preview your build locally, before deploying |
45-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
46-
| `npm run astro -- --help` | Get help using the Astro CLI |
44+
This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
4745

48-
## 👀 Want to learn more?
46+
## License
4947

50-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
48+
See [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)