docs: update README
This commit is contained in:
parent
4985a61b9a
commit
221b74063f
55
README.md
55
README.md
|
@ -1,54 +1,5 @@
|
|||
# [Peripatos](https://term.m4tt72.com)
|
||||
# Peripatos
|
||||
|
||||
A terminal style website
|
||||
Peripatos is a invitation only group event. A curated group of thought leaders for Logos or brand ambassadors to have a closed meeting dinner as a first event in a chose city
|
||||
|
||||
![screenshot](/docs/screenshot.png)
|
||||
|
||||
## IMPORTANT
|
||||
|
||||
This is a new version of [m4tt72/terminal](https://github.com/m4tt72/terminal), which is built with [Svelte](https://svelte.dev/).
|
||||
|
||||
If you are looking for the old version, please check out the [v2 branch](https://github.com/m4tt72/terminal/tree/v2).
|
||||
|
||||
The old version is built with [React](https://reactjs.org/), and it is no longer maintained.
|
||||
|
||||
Thanks!
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Using docker (recommended)
|
||||
|
||||
```bash
|
||||
docker run -d --name terminal -p 3000:3000 ghcr.io/m4tt72/terminal
|
||||
```
|
||||
|
||||
### Using npm/yarn
|
||||
|
||||
1. Install dependencies:
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
3. Run the server:
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
## Themes
|
||||
|
||||
![themes](/docs/screenshot.gif)
|
||||
|
||||
[Here's](/docs/themes) a list of available themes.
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
Please feel free to pull requests or log issues.
|
||||
|
||||
Thanks!
|
||||
|
||||
## Star History
|
||||
|
||||
[![Star History Chart](https://api.star-history.com/svg?repos=m4tt72/terminal&type=Date)](https://star-history.com/#m4tt72/terminal&Date)
|
||||
- [p.free.technology](https://p.free.technology/)
|
||||
|
|
Loading…
Reference in New Issue