Update README.md

This commit is contained in:
Christopher Woodall
2023-05-14 18:07:09 -05:00
parent ce732fe860
commit a984d9bcaa

View File

@@ -2,18 +2,18 @@
``` ```
. . . . . . . . . . . . . . . . . .
. . . ________ . . . ________
. ///////// . . . . . . . ///////// . . . . . .
. ________ . . ///////// . . . ________ . . ///////// . .
|.____. /\ ///////// . . . . |.____. /\ ///////// . . . .
. // \/ |\ ///////// . // \/ |\ /////////
// \ | \ ///////// _______ _______ _______ _____ __ _ _______ _______ . // \ | \ ///////// _______ _______ _______ _____ __ _ _______ _______ .
|| | | ///////// . . |______ |_____| | | | \ | | |______ | || | | ///////// . . |______ |_____| | | | \ | | |______ |
. || | |// ///// ______| | | | __|__ | \_| | |______ |_____ . . || | |// ///// ______| | | | __|__ | \_| | |______ |_____ .
\\ / // \/ . \\ / // \/ .
\\.___./ //\ ,_\ . . . \\.___./ //\ ,_\ . . .
. . \ //////\ / \ . . Satellite OSINT CLI Tool . . . . \ //////\ / \ . . Satellite OSINT CLI Tool . .
. ///////// \| | . . ///////// \| | .
. ///////// . \ __ / . Made by Angelina Tsuboi (G4LXY) . . ///////// . \ __ / . Made by Angelina Tsuboi (G4LXY) .
. ///////// . . . . ///////// . . .
. . ///////// . . . . . . . . ///////// . . . . . .
@@ -26,7 +26,7 @@
### Features ### Features
- Satellite Catalog Retrieval from NORAD ID or Selection Menu - Satellite Catalog Retrieval from NORAD ID or Selection Menu
- Display Satellite Telemetry - Display Satellite Telemetry
- Visual and Radio Orbital Predictions - Visual and Radio Orbital Predictions
- Parse Two Line Elements (TLE) - Parse Two Line Elements (TLE)
### Preview ### Preview
@@ -37,17 +37,17 @@ Make an account at [**Space Track**](https://space-track.org) save username and
Create an account at [**N2YO**](https://n2yo.com) and save API key. Create an account at [**N2YO**](https://n2yo.com) and save API key.
Update `main.go` to have proper credentials The CLI will prompt for both Space Track and N2YO credentials if none are present in your environmental variables. To export your credentials enter the following commands:
``` ```bash
os.Setenv("SPACE_TRACK_USERNAME", "username") $ export SPACE_TRACK_USERNAME="YOUR_USER_NAME"
os.Setenv("SPACE_TRACK_PASSWORD", "password") $ export SPACE_TRACK_PASSWORD="YOUR_PASSWORD"
os.Setenv("N2YO_API_KEY", "api-key") $ export N2YO_API_KEY="YOUR_API_KEY"
``` ```
To build from source, you will need Go installed. To build from source, you will need Go installed.
```bash ```bash
$ export GO111MODULE=on $ export GO111MODULE=on
$ go get ./... $ go get ./...
$ go run main.go $ go run main.go
``` ```
@@ -61,5 +61,5 @@ To get a general overview of the underlying concepts of this tool, [read this ar
### Upcoming Features ### Upcoming Features
+ [ ] Map Layout of Satellite Positioning + [ ] Map Layout of Satellite Positioning
+ [ ] Including the [SGP4 Algorithm](joshuaferrara/go-satellite) for Position Prediction + [ ] Including the [SGP4 Algorithm](joshuaferrara/go-satellite) for Position Prediction