Skip to content

Commit 52c9b5b

Browse files
Merge pull request #50 from dineshgowda24/update-readme
update readme
2 parents 105b1ea + 7d833fa commit 52c9b5b

File tree

4 files changed

+13
-10
lines changed

4 files changed

+13
-10
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,6 @@ The workflow is organized around three main concepts:
9898

9999
- Keep contributions focused and atomic (one PR per logical change).
100100
- Follow the existing code structure and style for consistency.
101-
- Tests(if possible) and documentation updates are highly appreciated!
102-
103101

104102
## Thank You! 🙏
105103

INSTALLATION.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Installation
22

3-
First off**I'm sorry you're seeing this!**
3+
First off, **I'm sorry you're reading this!**
44
You probably ran into an issue during setup, and this page is here to get you back on track.
5-
You weren’t supposed to land here, but no worries I’ll guide you through it step by step.
5+
You weren’t supposed to land here, but no worries, I’ll guide you through it step by step.
66

77
---
88

@@ -53,7 +53,7 @@ Copy the result and paste it into Alfred. If it's correct, you’ll see a ✅ su
5353

5454
Now just hit <kbd>Enter</kbd> or <kbd>Tab</kbd> again to go to the home screen of the workflow.
5555

56-
From here, you can explore services, search resources, or manage configurations all with Alfred's lightning-fast speed.
56+
From here, you can explore services, search resources, or manage configurations, all with Alfred's lightning-fast speed.
5757
![Step 4](assets/docs/home.png)
5858

5959
---

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@
88

99
An Alfred workflow that lets you instantly open Google Cloud services or search GCP resources—fast, simple, and right from your Alfred.
1010

11-
<p align="center"> <img src="./docs/assets/demo.gif" alt="Demo GIF" width="700"/> </p>
11+
<p align="center"> <img src="./docs/assets/demo.gif" alt="Demo GIF" width="700"/> </p>
12+
13+
## Requirements
14+
15+
- [Alfred 3+](https://www.alfredapp.com/) (with Powerpack)
16+
- [Google Cloud CLI](https://cloud.google.com/sdk/docs/install) installed and authenticated
1217

1318
## Installation
1419

@@ -25,13 +30,13 @@ An Alfred workflow that lets you instantly open Google Cloud services or search
2530
- 🔍⚡️ Search live GCP resources across 20+ services, right from Alfred
2631
- ⚡ Instantly copy, paste or open GCP Console links without touching your browser
2732
- 🧠 Config and region overrides using simple symbols (`@` and `$`)
28-
- 🔐 Secure by design uses your local `gcloud` CLI, never touches credentials
33+
- 🔐 Secure by design, uses your local `gcloud` CLI, never touches credentials
2934
- 💾 Fast performance with safe caching (customizable via env var)
30-
- 🛠️ Built-in tools to clear cache, view logs, or reset internal data
35+
- 🛠️ Built-in tools to install new updates, clear cache, view logs, or reset internal data
3136

3237
## Design Philosophy
3338

34-
1. This workflow never sees your credentials authentication is handled entirely by the `gcloud` CLI.
39+
1. This workflow never sees your credentials, authentication is handled entirely by the `gcloud` CLI.
3540
2. Only non-sensitive data is cached, such as project names, regions, resource names etc. Jusk enough keep things snappy.
3641
3. Every command fetches only the non sensitive data it needs, keeping it lightweight and efficient.
3742
4. Set your `gcloud` path once, and the workflow runs smoothly without surprises.
@@ -67,7 +72,7 @@ An Alfred workflow that lets you instantly open Google Cloud services or search
6772
- Compute snapshots
6873
- Compute instance templates
6974
- Pub/Sub topics and subscriptions
70-
_This is not an exhaustive list if changing the region has no effect, the resource is likely global._
75+
_This is not an exhaustive list: if changing the region has no effect, the resource is likely global._
7176

7277

7378
### Advanced Usage

assets/docs/install_step1.png

2.3 KB
Loading

0 commit comments

Comments
 (0)