mirror of
https://github.com/AikidoSec/safe-chain.git
synced 2026-05-26 12:10:49 +00:00
Merge pull request #208 from AikidoSec/readme-fixes
Hard-code links and remove outdated information from readme
This commit is contained in:
commit
68ed31c6ee
2 changed files with 7 additions and 9 deletions
10
README.md
10
README.md
|
|
@ -1,4 +1,4 @@
|
||||||

|

|
||||||
|
|
||||||
# Aikido Safe Chain
|
# Aikido Safe Chain
|
||||||
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
- ✅ **Blocks packages newer than 24 hours** without breaking your build
|
- ✅ **Blocks packages newer than 24 hours** without breaking your build
|
||||||
- ✅ **Tokenless, free, no build data shared**
|
- ✅ **Tokenless, free, no build data shared**
|
||||||
|
|
||||||
Aikido Safe Chain works on Node.js version 16 and above and supports the following package managers:
|
Aikido Safe Chain supports the following package managers:
|
||||||
|
|
||||||
- 📦 **npm**
|
- 📦 **npm**
|
||||||
- 📦 **npx**
|
- 📦 **npx**
|
||||||
|
|
@ -29,7 +29,7 @@ Aikido Safe Chain works on Node.js version 16 and above and supports the followi
|
||||||
|
|
||||||
Installing the Aikido Safe Chain is easy with our one-line installer.
|
Installing the Aikido Safe Chain is easy with our one-line installer.
|
||||||
|
|
||||||
> ⚠️ **Already installed via npm?** See the [migration guide](docs/npm-to-binary-migration.md) to switch to the binary version.
|
> ⚠️ **Already installed via npm?** See the [migration guide](https://github.com/AikidoSec/safe-chain/blob/main/docs/npm-to-binary-migration.md) to switch to the binary version.
|
||||||
|
|
||||||
### Unix/Linux/macOS
|
### Unix/Linux/macOS
|
||||||
|
|
||||||
|
|
@ -111,7 +111,7 @@ The Aikido Safe Chain integrates with your shell to provide a seamless experienc
|
||||||
- ✅ **PowerShell**
|
- ✅ **PowerShell**
|
||||||
- ✅ **PowerShell Core**
|
- ✅ **PowerShell Core**
|
||||||
|
|
||||||
More information about the shell integration can be found in the [shell integration documentation](docs/shell-integration.md).
|
More information about the shell integration can be found in the [shell integration documentation](https://github.com/AikidoSec/safe-chain/blob/main/docs/shell-integration.md).
|
||||||
|
|
||||||
## Uninstallation
|
## Uninstallation
|
||||||
|
|
||||||
|
|
@ -182,8 +182,6 @@ You can set the minimum package age through multiple sources (in order of priori
|
||||||
|
|
||||||
You can protect your CI/CD pipelines from malicious packages by integrating Aikido Safe Chain into your build process. This ensures that any packages installed during your automated builds are checked for malware before installation.
|
You can protect your CI/CD pipelines from malicious packages by integrating Aikido Safe Chain into your build process. This ensures that any packages installed during your automated builds are checked for malware before installation.
|
||||||
|
|
||||||
For optimal protection in CI/CD environments, we recommend using **npm >= 10.4.0** as it provides full dependency tree scanning. Other package managers currently offer limited scanning of install command arguments only.
|
|
||||||
|
|
||||||
## Installation for CI/CD
|
## Installation for CI/CD
|
||||||
|
|
||||||
Use the `--ci` flag to automatically configure Aikido Safe Chain for CI/CD environments. This sets up executable shims in the PATH instead of shell aliases.
|
Use the `--ci` flag to automatically configure Aikido Safe Chain for CI/CD environments. This sets up executable shims in the PATH instead of shell aliases.
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@ Depending on the version manager you're using, the uninstall process differs:
|
||||||
npm uninstall -g @aikidosec/safe-chain
|
npm uninstall -g @aikidosec/safe-chain
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Install the binary version** (see [Installation](../README.md#installation))
|
4. **Install the binary version** (see [Installation](https://github.com/AikidoSec/safe-chain/blob/main/README.md#installation))
|
||||||
|
|
||||||
### nvm (Node Version Manager)
|
### nvm (Node Version Manager)
|
||||||
|
|
||||||
|
|
@ -51,7 +51,7 @@ Depending on the version manager you're using, the uninstall process differs:
|
||||||
|
|
||||||
Repeat for each Node version where safe-chain was installed.
|
Repeat for each Node version where safe-chain was installed.
|
||||||
|
|
||||||
4. **Install the binary version** (see [Installation](../README.md#installation))
|
4. **Install the binary version** (see [Installation](https://github.com/AikidoSec/safe-chain/blob/main/README.md#installation))
|
||||||
|
|
||||||
### Volta
|
### Volta
|
||||||
|
|
||||||
|
|
@ -69,7 +69,7 @@ Depending on the version manager you're using, the uninstall process differs:
|
||||||
volta uninstall @aikidosec/safe-chain
|
volta uninstall @aikidosec/safe-chain
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Install the binary version** (see [Installation](../README.md#installation))
|
4. **Install the binary version** (see [Installation](https://github.com/AikidoSec/safe-chain/blob/main/README.md#installation))
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue