Skip to content

Commit d594010

Browse files
author
Hunter T
committed
docs(README): update README.md
1 parent 0035bb4 commit d594010

1 file changed

Lines changed: 26 additions & 8 deletions

File tree

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,43 @@
44
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
55
-->
66

7-
[![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive)
8-
![Repo Size](https://img.shields.io/github/repo-size/StrangeRanger/linux-security-scripts)
7+
[![Project Tracker](https://img.shields.io/badge/repo%20status-Project%20Tracker-lightgrey)](https://randomserver.xyz/project-tracker.html)
8+
[![Style Guide](https://img.shields.io/badge/code%20style-Style%20Guide-blueviolet)](https://github.com/StrangeRanger/bash-style-guide)
99
[![CodeFactor](https://www.codefactor.io/repository/github/strangeranger/linux-security-scripts/badge)](https://www.codefactor.io/repository/github/strangeranger/linux-security-scripts)
1010

11-
This repository is a collection of scripts designed to secure/harden Linux based distributions.
11+
This repository is a collection of scripts designed to secure/harden Linux based Distributions.
1212

13-
For information on each of the scripts, visit the [repo wiki](https://github.com/StrangeRanger/linux-security-scripts/wiki). Each page will provide information on the script in questions, example output, and a changelog.
13+
For information on each of the scripts, visit the [repo wiki](https://github.com/StrangeRanger/linux-security-scripts/wiki). Each page will provide information on the script in question, example output, and a changelog.
1414

15-
## Other Resources
15+
## Getting Started
1616

17-
This repository is still a work in progress. While it has scripts that can help secure Linux, it's not nearly enough to secure the system as much as it needs to be. Below is a list of other resources that you can use to help make Linux as secure as possible.
17+
### Prerequisites
1818

19-
- [SSH Audit](https://github.com/jtesta/ssh-audit) - SSH server & client auditing (banner, key exchange, encryption, mac, compression, compatibility, security, etc).
19+
N/A
20+
21+
### Installing
22+
23+
All you need to do is download the repository. There are no binaries or anything to install.
24+
25+
`git clone https://github.com/StrangeRanger/linux-security-scripts`
26+
27+
## Usage
28+
29+
A majority of the scripts will require root privilege to be executed:
30+
31+
`sudo ./[script name]` OR `sudo bash [script name]`
2032

2133
## Tested On
2234

23-
Below is a list of Linux Distributions that the security scripts have been tested and confirmed to work on.
35+
Below is a list of Linux Distributions that all of the scripts have been tested and confirmed to work on.
2436

2537
| Distributions | Distro Versions |
2638
| ------------- | --------------- |
2739
| Ubuntu | 20.04<br>18.04 |
2840
| Debian | 10<br>9 |
41+
42+
## Other Resources
43+
44+
This repository is still a work in progress. While it has scripts that can help secure Linux, it's not nearly enough to secure the system as much as it needs to be. Below is a list of other resources that you can use to help make your system as secure as possible.
45+
46+
- [SSH Audit](https://github.com/jtesta/ssh-audit) - SSH server & client auditing (banner, key exchange, encryption, mac, compression, compatibility, security, etc).

0 commit comments

Comments
 (0)