Skip to content

Commit 93856fe

Browse files
committed
d - Reference the installation documentation
1 parent 0e98f53 commit 93856fe

File tree

1 file changed

+2
-29
lines changed

1 file changed

+2
-29
lines changed

README.md

+2-29
Original file line numberDiff line numberDiff line change
@@ -63,46 +63,19 @@ While focused on AWS, Luminaut can be extended to support other cloud providers
6363

6464
## Installation
6565

66-
### via python
67-
6866
Luminaut is available on PyPI and can be installed with pip:
6967

7068
```bash
7169
pip install luminaut
7270
```
7371

74-
You can also download a release artifact from the [GitHub releases page](https://github.com/luminaut-org/luminaut/releases) and install it with pip.
75-
76-
Once installed, you can run luminaut from the command line.
77-
78-
```bash
79-
luminaut --help
80-
```
81-
82-
**Note:** Luminaut requires Python 3.11 or later. If you would like to leverage nmap or whatweb, you will need to install these tools separately.
83-
84-
### via docker
85-
86-
The docker image is available on GitHub, you can pull it locally by running:
72+
There is also a docker image available on GitHub, you can pull it locally by running:
8773

8874
```bash
8975
docker pull ghcr.io/luminaut-org/luminaut
9076
```
9177

92-
If you would like to run it locally with just the name `luminaut`, you can then run:
93-
94-
```bash
95-
docker tag ghcr.io/luminaut-org/luminaut luminaut:latest
96-
```
97-
98-
For development, clone the repository and run `docker build --tag luminaut:latest` to build the container.
99-
100-
You can then run the container with:
101-
102-
```bash
103-
docker run -it luminaut --help
104-
```
105-
78+
Additional installation information is available within the [Luminaut documentation](https://luminaut-org.github.io/luminaut/installation.html)
10679

10780
## Usage
10881

0 commit comments

Comments
 (0)