c68626985e
This commit introduces several maintenance improvements to the repository. - A `go.work` file has been added to define the workspace and make the project easier to work with. - The module path in `go.mod` has been updated to use a GitHub URL, and all import paths have been updated accordingly. - `examples` and `docs` directories have been created. - The `examples` directory contains scripts that demonstrate the tool's functionality. - The `docs` directory contains documentation for the project. - Tests have been added to the `pkg/github` package following the `_Good`, `_Bad`, `_Ugly` convention. - The missing `pkg/borg` package has been added to resolve a build error.
33 lines
563 B
Markdown
33 lines
563 B
Markdown
# Usage
|
|
|
|
This document explains how to use the Borg Data Collector.
|
|
|
|
## `collect git`
|
|
|
|
The `collect git` command is used to clone a git repository and store it in a DataNode.
|
|
|
|
### Example
|
|
|
|
```bash
|
|
borg collect git --uri https://github.com/torvalds/linux.git
|
|
```
|
|
|
|
## `collect website`
|
|
|
|
The `collect website` command is used to crawl a website and store it in a DataNode.
|
|
|
|
### Example
|
|
|
|
```bash
|
|
borg collect website --uri https://tldp.org/
|
|
```
|
|
|
|
## `serve`
|
|
|
|
The `serve` command is used to serve a DataNode file.
|
|
|
|
### Example
|
|
|
|
```bash
|
|
borg serve --file linux.borg
|
|
```
|