Skip to content

Commit 05304da

Browse files
committed
updated readme
1 parent cfdc063 commit 05304da

1 file changed

Lines changed: 42 additions & 6 deletions

File tree

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ OPTIONS:
3535
-dns
3636
check for DNS records to determine if domain is registered
3737
-driver string
38-
driver(s) to use [censys, crtsh, http, smtp] (default "http")
38+
driver(s) to use [crtsh, smtp, censys, http] (default "http")
3939
-json
4040
print the graph as json, can be used for graph in web UI
4141
-parallel uint
@@ -88,14 +88,32 @@ The above output represents the adjacency list for the graph for the root domain
8888

8989
## [Releases](https://github.com/lanrat/certgraph/releases)
9090

91-
Pre-compiled releases will occasionally be uploaded to the [releases github page](https://github.com/lanrat/certgraph/releases). [https://github.com/lanrat/certgraph/releases](https://github.com/lanrat/certgraph/releases)
91+
Pre-compiled releases are automatically built and uploaded to the [releases GitHub page](https://github.com/lanrat/certgraph/releases) using GitHub Actions. Releases are available for multiple platforms including Linux, macOS, and Windows.
9292

93-
### [Docker](https://hub.docker.com/r/lanrat/certgraph/)
93+
## CI/CD
9494

95-
CertGraph is an automated build on the Docker Hub!
95+
This project uses GitHub Actions for continuous integration and deployment:
9696

97+
- **Tests and Linting**: Automatically runs tests and linting on every push and pull request
98+
- **Docker Images**: Automatically builds and pushes Docker images to GitHub Container Registry on version tags
99+
- **Releases**: Automatically creates releases with pre-compiled binaries for multiple platforms using GoReleaser
100+
101+
### Docker
102+
103+
CertGraph is available as Docker images on both Docker Hub and GitHub Container Registry:
104+
105+
**Docker Hub:**
97106
```console
98107
$ docker run --rm -it lanrat/certgraph example.com
108+
```
109+
110+
**GitHub Container Registry:**
111+
```console
112+
$ docker run --rm -it ghcr.io/lanrat/certgraph example.com
113+
```
114+
115+
**Example output:**
116+
```console
99117
example.com
100118
www.example.net
101119
www.example.org
@@ -113,20 +131,38 @@ www.example.edu
113131

114132
## Compiling
115133

116-
To compile certgraph you must have a working go 1.16 or newer compiler on your system.
134+
To compile certgraph you must have a working Go 1.23 or newer compiler on your system.
117135
To compile for the running system compilation is as easy as running make
118136

119137
```console
120138
certgraph$ make
121139
go build -o certgraph certgraph.go
122140
```
123141

124-
Alternatively you can use `go get` to install with this one-liner:
142+
Alternatively you can use `go install` to install with this one-liner:
125143

126144
```console
127145
go install github.com/lanrat/certgraph@latest
128146
```
129147

148+
### Development
149+
150+
For development, you can build and test the project using the provided Makefile:
151+
152+
```console
153+
# Build the binary
154+
make
155+
156+
# Run tests
157+
make test
158+
159+
# Run linting
160+
make lint
161+
162+
# Build Docker image locally
163+
make docker
164+
```
165+
130166
## [Web UI](https://lanrat.github.io/certgraph/)
131167

132168
A web UI is provided in the docs folder and is accessible at the github pages url [https://lanrat.github.io/certgraph/](https://lanrat.github.io/certgraph/), or can be run from the embedded web server by calling `certgraph --serve 127.0.0.1:8080`.

0 commit comments

Comments
 (0)