Skip to content

Commit

Permalink
docs: Change README
Browse files Browse the repository at this point in the history
  • Loading branch information
NriotHrreion committed Aug 9, 2024
1 parent 9e99e0d commit a0655f3
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
# Ferrum Explorer

[![Author](https://img.shields.io/badge/Author-NriotHrreion-red.svg "Author")](https://github.com/NriotHrreion)
[![LICENSE](https://img.shields.io/badge/license-MIT-green.svg "LICENSE")](./LICENSE)
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg "LICENSE")](./LICENSE)
[![Stars](https://img.shields.io/github/stars/nocpiun/ferrum.svg?label=Stars)](https://github.com/nocpiun/ferrum/stargazers)
[![test](https://img.shields.io/github/actions/workflow/status/nocpiun/ferrum/ci.yml)](https://github.com/nocpiun/ferrum/actions/workflows/ci.yml)
[![Netlify Status](https://api.netlify.com/api/v1/badges/4bbf93a7-63d0-4512-bb3a-09345632ad1e/deploy-status)](https://app.netlify.com/sites/inspiring-torte-1d7e94/deploys)

> Explore throughout your server
Expand All @@ -25,6 +26,10 @@ Because it's only maintained by me, so it might have some problems and bugs. You
File Explorer -> FE -> Fe (Chemical Element) -> Ferrum
```

#### May I have a look?

**[Demo Site](https://ferrum-demo.nin.red)** (Default password is `123456`)

## Deploy & Use

First, you need to make sure that your server (or computer) has installed Nodejs.
Expand Down Expand Up @@ -65,14 +70,6 @@ git merge temp
npm i
```

If error at `npm i`, just try:

```bash
npm i --legacy-peer-deps
# or
npm i --force
```

### Something to notice

Ferrum Explorer requires ports `3300` to launch. If you see it reports `address already in use :::xxxx`, you should have a check to whether you've launched Ferrum Explorer and whether other apps are using the ports. And see the following steps.
Expand Down

0 comments on commit a0655f3

Please sign in to comment.