Skip to content

Commit

Permalink
docs: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hanssen0 committed Jan 22, 2024
1 parent 07f4297 commit 38d1e2d
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 44 deletions.
89 changes: 45 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,42 @@
This project was bootstrapped with
[Create React App](https://github.com/facebook/create-react-app).

## Available Scripts
<p align="center">
<a href="https://chain-idle.vercel.app/">
<img alt="Logo" src="https://raw.githubusercontent.com/handsome0hell/chain-idle/master/assets/logo.svg" width="12.5%" />
</a>
</p>

<h1 align="center" style="font-size: 48px;">
Chain Idle
</h1>

<p align="center">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/handsome0hell/chain-idle">
<img alt="GitHub last commit (branch)" src="https://img.shields.io/github/last-commit/handsome0hell/chain-idle/master">
<img alt="GitHub deployments" src="https://img.shields.io/github/deployments/handsome0hell/chain-idle/production">
<img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fchain-idle.vercel.app%2F">
</p>

<p align="center">
<a href="https://chain-idle.vercel.app/">Chain Idle</a>
is a browser-based on-chain idle game about enlarging your blockchain.
<br />
You will unlock more game content and background stories as the game progresses.
<br />
Your chain will grow incredibly, and you will learn from it.
<br />
Besides, you can discover NFTs and trade with others while playing.
</p>

## Preview

<p align="center">
<a href="https://chain-idle.vercel.app/">
<img src="https://raw.githubusercontent.com/handsome0hell/chain-idle/master/assets/poster.png" width="61.8%" />
</a>
</p>

This project is still under active development, and we are looking forward to your feedback. [Try it now here](https://chain-idle.vercel.app/).

## Start it locally

In the project directory, you can run:

Expand All @@ -10,50 +45,16 @@ In the project directory, you can run:
Runs the app in the development mode.<br /> Open
[http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br /> You will also see any lint errors
in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.<br /> See the section
about
[running tests](https://facebook.github.io/create-react-app/docs/running-tests)
for more information.
The page will reload if you make edits.

### `yarn build`

Builds the app for production to the `build` folder.<br /> It correctly bundles
React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br /> Your app is
ready to be deployed!

See the section about
[deployment](https://facebook.github.io/create-react-app/docs/deployment) for
more information.
Builds the app for production to the `build` folder.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can
`eject` at any time. This command will remove the single build dependency from
your project.

Instead, it will copy all the configuration files and the transitive
dependencies (webpack, Babel, ESLint, etc) right into your project so you have
full control over them. All of the commands except `eject` will still work, but
they will point to the copied scripts so you can tweak them. At this point
you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for
small and middle deployments, and you shouldn’t feel obligated to use this
feature. However we understand that this tool wouldn’t be useful if you couldn’t
customize it when you are ready for it.
### `yarn test`

## Learn More
Launches the test runner in the interactive watch mode.

You can learn more in the
[Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
## Links

To learn React, check out the [React documentation](https://reactjs.org/).
* Also try [Exponential Idle](https://conicgames.github.io/exponentialidle/), from where our ideas come.
File renamed without changes
Binary file added assets/poster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 38d1e2d

Please sign in to comment.