Skip to content

Commit 1a51082

Browse files
author
Rahul Raj
committed
Docs: Updated Readme
1 parent 451aef2 commit 1a51082

1 file changed

Lines changed: 85 additions & 24 deletions

File tree

README.md

Lines changed: 85 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -73,53 +73,114 @@ Before you begin, ensure you have the following:
7373

7474
Ensure the following tools and files are available on your system:
7575

76-
1. **Deno** - runtime required by Spry
77-
2. **Homebrew (brew)** - package manager for installing dependencies
78-
3. **Spry** - runbook and SQLPage orchestration engine
79-
4. **Surveilr** - ingestion and transformation engine
80-
5. **Qualityfolio Extension** - Visual Studio Code Extension/Cursor IDE Extension which simplifies editing Evidence Block values
76+
1. **Spry** - runbook and SQLPage orchestration engine
77+
2. **Surveilr** - ingestion and transformation engine
78+
3. **Python 3.8+** - primary language for singer taps,only required if using Singer
8179

8280
#### 2. Quick Install Commands
8381

8482
**For Linux:**
8583

8684
```bash
87-
# 1. Install Deno
88-
curl -fsSL https://deno.com/install.sh | sh
85+
# 1. Install Spry
86+
brew install programmablemd/packages/spry
87+
```
88+
89+
For more details on Spry installation and usage, refer to the [official Spry documentation](https://docs.opsfolio.com/spry/getting-started/installation).
90+
91+
```bash
92+
# 2. Install Surveilr
93+
brew tap surveilr/tap && brew install surveilr
94+
```
8995

90-
# 2. Install Homebrew
91-
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
96+
For more details on Surveilr installation and usage, refer to the [official Surveilr documentation](https://docs.opsfolio.com/surveilr/core/installation).
9297

93-
# 3. Install Spry
98+
**For macOS:**
99+
100+
```bash
101+
# 1. Install Spry
94102
brew install programmablemd/packages/spry
103+
```
104+
105+
For more details on Spry installation and usage, refer to the [official Spry documentation](https://docs.opsfolio.com/spry/getting-started/installation).
106+
107+
```bash
108+
# 2. Install Surveilr
109+
brew tap surveilr/tap && brew install surveilr
110+
```
111+
112+
For more details on Surveilr installation and usage, refer to the [official Surveilr documentation](https://docs.opsfolio.com/surveilr/core/installation).
113+
114+
#### 3. Install Qualityfolio Extension (for Visual Studio Code/Cursor IDE)
115+
116+
To install Qualityfolio extension, download and install the pre-packaged extension for Visual Studio Code or Cursor IDE from the links below:
95117

96-
# 4. Install Surveilr
97-
wget https://github.com/surveilr/packages/releases/download/3.31.0/surveilr_3.31.0_x86_64-unknown-linux-gnu.tar.gz
98-
tar -xzf surveilr_3.31.0_x86_64-unknown-linux-gnu.tar.gz
99-
sudo mv surveilr /usr/local/bin/
118+
<details>
119+
<summary>View Extension Installation Steps</summary>
100120

121+
**For Linux:**
122+
123+
**For Visual Studio Code:**
124+
125+
1. Download the **Qualityfolio** extension package:
126+
127+
```bash
128+
wget https://github.com/opsfolio/qualityfolio/raw/refs/heads/main/extension/qualityfolio-extension-0.0.1.vsix
129+
```
130+
131+
2. Install the extension package:
132+
133+
```bash
134+
code --install-extension ./qualityfolio-extension-0.0.1.vsix
135+
```
136+
137+
**For Cursor IDE:**
138+
139+
1. Download the **Qualityfolio** extension package:
140+
141+
```bash
142+
wget https://github.com/opsfolio/qualityfolio/raw/refs/heads/main/extension/qualityfolio-extension-0.0.1.vsix
143+
```
144+
145+
2. Install the extension:
146+
147+
```bash
148+
cursor --install-extension ./qualityfolio-extension-0.0.1.vsix
101149
```
102150

103151
**For macOS:**
104152

153+
**For Visual Studio Code:**
154+
155+
1. Download the **Qualityfolio** extension package:
156+
105157
```bash
106-
# 1. Install Deno
107-
curl -fsSL https://deno.com/install.sh | sh
158+
curl -L -o qualityfolio-extension-0.0.1.vsix \
159+
https://github.com/opsfolio/qualityfolio/raw/refs/heads/main/extension/qualityfolio-extension-0.0.1.vsix
160+
```
108161

109-
# 2. Install Homebrew
110-
curl -fsSL -o install.sh https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh
162+
2. Install the extension package:
111163

112-
# 3. Install Spry
113-
brew install programmablemd/packages/spry
164+
```bash
165+
code --install-extension ./qualityfolio-extension-0.0.1.vsix
166+
```
114167

115-
# 4. Install Surveilr
116-
brew tap surveilr/tap && brew install surveilr
168+
**For Cursor IDE:**
117169

170+
1. Download the **Qualityfolio** extension package:
171+
172+
```bash
173+
curl -L -o qualityfolio-extension-0.0.1.vsix \
174+
https://github.com/opsfolio/qualityfolio/raw/refs/heads/main/extension/qualityfolio-extension-0.0.1.vsix
118175
```
119176

120-
#### 3. Install Qualityfolio Extension (for Visual Studio Code/Cursor IDE)
177+
2. Install the extension:
178+
179+
```bash
180+
cursor --install-extension qualityfolio-extension-0.0.1.vsix
181+
```
121182

122-
To install Qualityfolio extension, download and install the pre-packaged extension for Visual Studio Code or Cursor IDE.
183+
</details>
123184

124185
> Tip: The Qualityfolio extension simplifies editing Evidence Block values directly within your IDE.
125186

0 commit comments

Comments
 (0)