Skip to content

Commit

Permalink
feat(docs): updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CorentinTh committed Apr 9, 2023
1 parent c476ef0 commit a0312f1
Showing 1 changed file with 5 additions and 21 deletions.
26 changes: 5 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Another pastebin with a clean and minimalist ui. Made for selfhosting.

Disclamer: still WIP

![screenshot](./.github/screenshot.png)

## Host your instance
Expand All @@ -12,8 +10,6 @@ Disclamer: still WIP

Install using docker

// TODO: write procedure

### Configuration

| ENV variable | Default value | Format | Description |
Expand All @@ -34,46 +30,34 @@ Install using docker
To contribute to this project, first clone this repo

```bash
git clone git@github.com:cauctus/projo.git
git clone git@github.com:CorentinTh/snut.git
```

### Installation

```bash
$ npm install
pnpm i
```

### Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
pnpm dev
```

### Test

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
pnpm test
```

## Credits

Coded with ❤️ by [Corentin Thomasset](https://github.com/CorentinTh).

Name found with ❤️ by [Aimie Tremoureux](https://twitter.com/Aimie39949465).
Name found with ❤️ by [Aimie Tremoureux](https://twitter.com/dwenna_art).

## License

Expand Down

0 comments on commit a0312f1

Please sign in to comment.