Skip to content

Commit

Permalink
docs: add new readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lxchapu committed Aug 20, 2023
1 parent bd44b15 commit 5d8d11e
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,38 @@
# arknights
# Arknights 明日方舟(Vue)

This repository contains the source code for Arknights (明日方舟), built with Vue.js. It aims to provide a web-based interface for the Arknights game.

## Features

- 🎱 Home page with parallax effect
- 🎵 Bgm and character voice

## Demo

You can see a live demo of the project at [arknights.lxchapu.com](https://arknights.lxchapu.com/).

## Installation

To run this project locally, follow these steps:

1. Clone the repository: `git clone https://github.com/lxchapu/arknights.git`
1. Navigate to the project directory: `cd arknights`
1. Install the dependencies: `pnpm install`

## Usage

To start the development server, run the following command:

```bash
pnpm dev
```

This will start the development server at `http://localhost:8080`.

## Contributing

Contributions are welcome! If you find any issues or have suggestions, please open an issue or submit a pull request.

## License

This project is licensed under the [MIT](https://opensource.org/license/mit/) License. Enjoy!

0 comments on commit 5d8d11e

Please sign in to comment.