Update documentation and links

This commit is contained in:
Kevin Thomas
2022-04-15 16:10:57 -07:00
parent 0a6bf8b44d
commit 06d4f10208
6 changed files with 15 additions and 13 deletions

View File

@@ -1,5 +1,5 @@
FROM node:14
LABEL maintainer="me@kevinthomas.dev"
LABEL maintainer="kaythomas@pm.me"
WORKDIR /var/noisedash
COPY package*.json ./
RUN npm install

View File

@@ -4,7 +4,7 @@ Self-hostable web tool for generating ambient noises
![Noisedash](./.github/noisedash-screenshot-1.jpg)
(More screenshots on the [wiki](https://github.com/KevinThomas0/noisedash/wiki/Screenshots))
(More screenshots on the [wiki](https://github.com/kaythomas0/noisedash/wiki/Screenshots))
# Features
@@ -21,8 +21,8 @@ Self-hostable web tool for generating ambient noises
Requires docker and docker-compose
* Download the provided [docker-compose.yml file](https://github.com/KevinThomas0/noisedash/blob/main/docker-compose.yml)
* In the same directory as the docker-compose file, created a folder called `config`, and inside it, put the provided [config file](https://github.com/KevinThomas0/noisedash/blob/main/config/default.json)
* Download the provided [docker-compose.yml file](https://github.com/kaythomas0/noisedash/blob/main/docker-compose.yml)
* In the same directory as the docker-compose file, created a folder called `config`, and inside it, put the provided [config file](https://github.com/kaythomas0/noisedash/blob/main/config/default.json)
* Edit the config file to your preference
* Bring the container up:
@@ -32,6 +32,8 @@ docker-compose up -d
* Proceed to the URL where it's deployed and register your first user
(Raspberry Pi compatible images are available, see armv7 images on [Docker Hub](https://hub.docker.com/repository/docker/noisedash/noisedash))
## From Source
Requires node 14 and npm
@@ -39,7 +41,7 @@ Requires node 14 and npm
* Clone the repo:
``` bash
git clone https://github.com/KevinThomas0/noisedash.git
git clone https://github.com/kaythomas0/noisedash.git
cd noisedash
```
@@ -62,4 +64,4 @@ npm run server-prod
# Contributing
See [CONTRIBUTING.md](https://github.com/KevinThomas0/noisedash/blob/main/CONTRIBUTING.md)
See [CONTRIBUTING.md](https://github.com/kaythomas0/noisedash/blob/main/CONTRIBUTING.md)

View File

@@ -2,7 +2,7 @@ version: "3"
services:
noisedash:
image: kevinthomas0/noisedash:latest
image: noisedash/noisedash:latest
container_name: noisedash
ports:
- "1432:1432"

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{
"name": "noisedash",
"version": "0.1.0",
"version": "0.2.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

View File

@@ -1,11 +1,11 @@
{
"name": "noisedash",
"descriptions": "Self-hostable web tool for generating ambient noises",
"homepage": "https://github.com/KevinThomas0/noisedash",
"bugs": "https://github.com/KevinThomas0/noisedash/issues",
"homepage": "https://github.com/kaythomas0/noisedash",
"bugs": "https://github.com/kaythomas0/noisedash/issues",
"license": "AGPL-3.0-or-later",
"author": "Kevin Thomas <me@kevinthomas.dev> (https://kevinthomas.dev)",
"version": "0.1.0",
"author": "Kay Thomas <kaythomas@pm.me> (https://kaythomas.dev)",
"version": "0.2.0",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",

View File

@@ -66,7 +66,7 @@
<template v-slot:append>
<v-btn
block
href="https://github.com/KevinThomas0/noisedash"
href="https://github.com/kaythomas0/noisedash"
target="_blank"
>
Source Code