Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sacramentix authored May 20, 2024
1 parent 17b3291 commit fc01862
Showing 1 changed file with 9 additions and 38 deletions.
47 changes: 9 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,55 +8,26 @@
</a>
</p>
<h4 align="center">
Wiki Adventure is a multiplayer game combining culture and speed. Players compete against each other on Wikipedia and have to scroll through the pages as quickly as possible to win.
...
</h4>

<p align="center">
<strong>
<a href="https://daily.wikiadventu.re">Play</a>
<a href="#-tech-stack">Tech stack</a>
<a href="#%EF%B8%8F-contributing">Contributing</a>
<a href="#run-the-project">Run the project</a>
</strong>
</p>


## 🚀 Tech stack

<p align="center">
<a href="https://bun.sh"><<img width="20" height="17.5" src="https://bun.sh/logo.svg" alt="Bun logo"></a>
<a href="https://bun.sh"><img width="30" height="26.25" src="https://bun.sh/logo.svg" alt="Bun logo"></a>
<a href="https://hono.dev"><img width="24" height="24" src="https://hono.dev/images/logo-small.png" alt="Hono logo"></a>
<a href="https://arangodb.com">🥑/a>
<a href="https://www.typescriptlang.org"><img width=32 height=32 src="https://upload.wikimedia.org/wikipedia/commons/4/4c/Typescript_logo_2020.svg" alt="Typescript logo"></a>
<a href="https://cloud.google.com/run"><img width=24 height=24 src="https://lh3.googleusercontent.com/x9DtAsJtDhTU3ebiBTNJTV4GWJwXXl8TDgwdMdG0bKPvhBpphPu9p3wnUP8y3G8ZFBmEpUQnh7LW=s24-w24-rj" alt="Cloud run logo"></a>
</p>

The project is a Progressive Web App made with Quasar with Vue and Typescript. It's deployed on Netlify.
The daily are simply store of file system for each day.
...

## 🖋️ Contributing

<p align="center">

</p>

Want to help with Wiki Adventure? Well first, Thank you so much for your interest! We are always appreciate for improvements to the project and contributions from open-source developers are greatly appreciated.
What you can do to help:
- Make the game available in your language.
- Add daily for your language of choice.
- Solve one of those issue (if there no issue we've made a great job!).
- Make a code review. It always good to have a second eye!
- Donate on [Ko-Fi](https://ko-fi.com/sacramentix) ❤️
...

## Run the project

#### Node js
- Make sure you have v14 or higher. You can install it from the official website [here](https://nodejs.org).
#### Librairies
- Install all the required librairies with
```
npm i
```
#### Run
```
npm start
```
...

0 comments on commit fc01862

Please sign in to comment.