Update README
All checks were successful
OSV-Scanner Scheduled Scan / scan-scheduled (push) Successful in 16s
CI / check (push) Successful in 21s
CI / build (push) Successful in 34s
Publish NPM Package / publish (push) Successful in 44s
Build and Publish Docker Image / build (push) Successful in 8m18s
All checks were successful
OSV-Scanner Scheduled Scan / scan-scheduled (push) Successful in 16s
CI / check (push) Successful in 21s
CI / build (push) Successful in 34s
Publish NPM Package / publish (push) Successful in 44s
Build and Publish Docker Image / build (push) Successful in 8m18s
This commit is contained in:
36
README.md
36
README.md
@@ -14,9 +14,41 @@ A client-side web linking tool for mapping relationships between entities.
|
||||
- Undo/Redo support
|
||||
- PWA support (installable, offline-capable)
|
||||
- Self-hostable
|
||||
- Mobile support
|
||||
|
||||
## Self-Hosting
|
||||
|
||||
### NPM
|
||||
|
||||
```sh
|
||||
npm config set @quad4:registry https://git.quad4.io/api/packages/quad4-software/npm/
|
||||
npm install -g @quad4/linking-tool
|
||||
linking-tool
|
||||
```
|
||||
Or
|
||||
|
||||
```sh
|
||||
PORT=3000 HOST=0.0.0.0 linking-tool
|
||||
```
|
||||
### Docker
|
||||
|
||||
```sh
|
||||
docker run -p 3000:3000 git.quad4.io/quad4-software/linking-tool
|
||||
```
|
||||
|
||||
### Podman
|
||||
|
||||
```sh
|
||||
podman run -p 3000:3000 git.quad4.io/quad4-software/linking-tool
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
git clone https://git.quad4.io/quad4-software/linking-tool.git
|
||||
cd linking-tool
|
||||
```
|
||||
|
||||
### NPM
|
||||
|
||||
```sh
|
||||
@@ -39,6 +71,10 @@ docker build -t quad4-linking-tool .
|
||||
docker run -p 3000:3000 quad4-linking-tool
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Send us a email at[team@quad4.io](mailto:team@quad4.io) for any issues or feedback.
|
||||
|
||||
## LICENSE
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user