Updated README file with new screenshots
unknown
BIN
.github/img/editor.png
vendored
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 84 KiB |
BIN
.github/img/home.png
vendored
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 37 KiB |
BIN
.github/img/snippet.png
vendored
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 52 KiB |
BIN
.github/img/snippets.png
vendored
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 97 KiB |
10
README.md
@@ -38,6 +38,7 @@ npm run dev
|
|||||||
### With Docker
|
### With Docker
|
||||||
|
|
||||||
#### Docker Hub
|
#### Docker Hub
|
||||||
|
|
||||||
[Docker Hub image link](https://hub.docker.com/r/pawelmalak/snippet-box).
|
[Docker Hub image link](https://hub.docker.com/r/pawelmalak/snippet-box).
|
||||||
For arm platforms use `:arm` tag.
|
For arm platforms use `:arm` tag.
|
||||||
|
|
||||||
@@ -51,7 +52,7 @@ docker build -t snippet-box .
|
|||||||
docker buildx build \
|
docker buildx build \
|
||||||
--platform linux/arm/v7,linux/arm64 \
|
--platform linux/arm/v7,linux/arm64 \
|
||||||
-f Dockerfile.arm \
|
-f Dockerfile.arm \
|
||||||
-t snippet-box:arm
|
-t snippet-box:arm .
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Deployment
|
#### Deployment
|
||||||
@@ -62,6 +63,10 @@ docker buildx build \
|
|||||||
docker run -p 5000:5000 -v /path/to/data:/app/data snippet-box
|
docker run -p 5000:5000 -v /path/to/data:/app/data snippet-box
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Without Docker
|
||||||
|
|
||||||
|
Follow instructions from wiki - [Installation without Docker](https://github.com/pawelmalak/snippet-box/wiki/Installation-without-Docker)
|
||||||
|
|
||||||
## Functionality
|
## Functionality
|
||||||
|
|
||||||
- Pinned snippets
|
- Pinned snippets
|
||||||
@@ -71,12 +76,13 @@ docker run -p 5000:5000 -v /path/to/data:/app/data snippet-box
|
|||||||
|
|
||||||
- Snippet library
|
- Snippet library
|
||||||
- Manage your snippets through snippet library
|
- Manage your snippets through snippet library
|
||||||
- Easily filter and access your code
|
- Easily filter and access your code using tags
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Snippet
|
- Snippet
|
||||||
- View your code, snippet details and documentation
|
- View your code, snippet details and documentation
|
||||||
|
- Built-in syntax highlighting
|
||||||
- Easily perform snippet actions like edit, pin or delete from a single place
|
- Easily perform snippet actions like edit, pin or delete from a single place
|
||||||
|
|
||||||
|
|
||||||
|
|||||||