Skip to content

Commit 0d1637b

Browse files
authored
Merge pull request #1382 from tobiasge/update-readme
Updates for new branch names
2 parents 64bf745 + 60db7e6 commit 0d1637b

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
Images are built regularly using the code in that repository and are pushed to [Docker Hub][netbox-dockerhub], [Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].
1212

1313
Do you have any questions?
14-
Before opening an issue on Github,
14+
Before opening an issue on GitHub,
1515
please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel.
1616

1717
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
@@ -63,37 +63,34 @@ New container images are built and published automatically every ~24h.
6363

6464
> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!
6565
66-
* `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
66+
- `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
6767
These are release builds containing _NetBox version_ `vX.Y.Z`.
6868
They contain the support files of _NetBox Docker version_ `a.b.c`.
6969
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
7070
These images are automatically built from [the corresponding releases of NetBox][netbox-releases].
71-
* `latest-a.b.c`:
71+
- `latest-a.b.c`:
7272
These are release builds, containing the latest stable version of NetBox.
7373
They contain the support files of _NetBox Docker version_ `a.b.c`.
7474
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
75-
These images are automatically built from [the `master` branch of NetBox][netbox-master].
76-
* `snapshot-a.b.c`:
75+
- `snapshot-a.b.c`:
7776
These are prerelease builds.
7877
They contain the support files of _NetBox Docker version_ `a.b.c`.
7978
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
80-
These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
79+
These images are automatically built from the [`main` branch of NetBox][netbox-main].
8180

8281
For each of the above tag, there is an extra tag:
8382

84-
* `vX.Y.Z`, `vX.Y`:
83+
- `vX.Y.Z`, `vX.Y`:
8584
This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
86-
It always points to the latest version of _NetBox Docker_.
87-
* `latest`
85+
- `latest`
8886
This is the same version as `latest-a.b.c`.
8987
It always points to the latest version of _NetBox Docker_.
90-
* `snapshot`
88+
- `snapshot`
9189
This is the same version as `snapshot-a.b.c`.
9290
It always points to the latest version of _NetBox Docker_.
9391

9492
[netbox-releases]: https://github.com/netbox-community/netbox/releases
95-
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
96-
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
93+
[netbox-main]: https://github.com/netbox-community/netbox/tree/main
9794

9895
## Documentation
9996

@@ -120,9 +117,9 @@ you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack ins
120117

121118
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
122119

123-
* The _Docker version_ must be at least `20.10.10`.
124-
* The _containerd version_ must be at least `1.5.6`.
125-
* The _docker-compose version_ must be at least `1.28.0`.
120+
- The _Docker version_ must be at least `20.10.10`.
121+
- The _containerd version_ must be at least `1.5.6`.
122+
- The _docker-compose version_ must be at least `1.28.0`.
126123

127124
To check the version installed on your system run `docker --version` and `docker compose version`.
128125

0 commit comments

Comments
 (0)