towk/makeshift
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

chore: minor changes to README

Browse source
This commit is contained in:
David Allen 2025-09-01 18:57:31 -06:00
parent b0f8adef2a
commit dc6a141ca1
Signed by: towk
GPG key ID: 0430CDBE22619155
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -38,7 +38,7 @@ Start the server. The `--init` flag with create the default files and directory
makeshift serve --root $HOME/apps/makeshift/server --init makeshift serve --root $HOME/apps/makeshift/server --init
``` ```
From here, you might want to see what files are available by default. From here, you might want to see what files, plugins, and profiles that are available by default.
```bash ```bash
# list the files in the root directory # list the files in the root directory
@ -60,7 +60,7 @@ makeshift list profiles
makeshift list profiles default makeshift list profiles default
``` ```
Then, we can start downloading some files or directories (as archives). Then, we can start downloading some files or directories (as archives) both with and without running plugins.
```bash ```bash
# download all data (notice --host and --port are not set here) # download all data (notice --host and --port are not set here)
@ -158,7 +158,7 @@ type Example struct{}
func (p *Example) Name() string { return "example" } func (p *Example) Name() string { return "example" }
func (p *Example) Version() string { return "v0.0.1-alpha" } func (p *Example) Version() string { return "v0.0.1-alpha" }
func (p *Example) Description() string { return "An example plugin" } func (p *Example) Description() string { return "An example plugin" }
func (p *Example) Metadata() map[string]string { func (p *Example) Metadata() map[string]any {
return makeshift.Metadata{ return makeshift.Metadata{
"author": map[string]any{ "author": map[string]any{
"name": "John Smith", "name": "John Smith",