oauth-init 0.8.0 → 0.11.0

package/.agents/skills/crafting-effective-readmes/using-references.md

@@ -0,0 +1,35 @@
+# Using References
+
+Templates are your primary tool for writing READMEs. References provide depth - use them to refine your understanding or handle edge cases.
+
+**Tip:** Don't load all references at once. Pick the one most relevant to your situation.
+
+---
+
+### art-of-readme.md
+`references/art-of-readme.md`
+
+**Why:** The philosophy behind great READMEs - understanding how readers actually scan and evaluate projects
+**What:** Cognitive funneling (broad → specific), brevity as a feature, README as the "one-stop shop" that keeps users out of source code
+
+---
+
+### make-a-readme.md
+`references/make-a-readme.md`
+
+**Why:** Practical, section-by-section guidance for what to include
+**What:** Walks through each common section (Name, Description, Installation, Usage, etc.) with concrete suggestions. Good reminder: "too long is better than too short"
+
+---
+
+### standard-readme-spec.md
+`references/standard-readme-spec.md`
+
+**Why:** Formal specification when consistency or compliance matters
+**What:** Required vs optional sections, exact ordering, formatting rules. Useful for OSS projects wanting a standardized format.
+
+Examples:
+- `references/standard-readme-example-minimal.md` - Bare minimum compliant README
+- `references/standard-readme-example-maximal.md` - Full-featured with badges, ToC, all optional sections
+
+

package/README.md

@@ -1,15 +1,69 @@
-# oauth-init
+<img width="474" height="110" alt="image" src="https://github.com/user-attachments/assets/57dc1bf8-19b5-45ba-b7fd-d4fb6dd111d3" />
 
-To install dependencies:
+## What This Does
+
+Setting up OAuth involves navigating multiple console pages, copying IDs, and managing credentials. This CLI walks you through the entire process interactively - fetching your Google Cloud projects, opening the right console pages, validating your inputs, and saving credentials wherever you need them.
+
+## Features
+
+- **Google OAuth** - Fetches your GCP projects, opens consent screen and credentials pages, captures client ID/secret
+- **GitHub OAuth Apps** - One-click GitHub App manifest or manual OAuth App setup
+- **Smart defaults** - Remembers your current gcloud project, suggests callback URLs
+- **Flexible output** - Save to `.env`, `.env.local`, `.json`, or just print to console
+- **Non-interactive mode** - `--no-open` flag for CI/automated environments
+
+## Installation
 
 ```bash
-bun install
+# Using bun (recommended)
+bun install -g oauth-init
+
+# Using npm
+npm install -g oauth-init
 ```
 
-To run:
+## Usage
 
 ```bash
-bun run src/cli.ts
+# Run interactive setup
+oauth-init
+
+# Run without opening browser pages
+oauth-init --no-open
+
+# Minimal output
+oauth-init --quiet
 ```
 
-This project was created using `bun init` in bun v1.3.9. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+The CLI will:
+1. Ask for your project name
+2. Select which OAuth providers to configure
+3. Guide you through each provider's setup flow
+4. Save credentials to your chosen location
+
+## Supported Providers
+
+| Provider | Setup Type |
+|----------|------------|
+| Google | OAuth 2.0 (External) |
+| GitHub | OAuth App, GitHub App |
+
+## Tech Stack
+
+- **Runtime**: Bun
+- **CLI UI**: @clack/prompts
+- **Shell**: execa
+- **Browser**: open
+
+## How It Works
+
+The CLI orchestrates the OAuth setup by:
+
+1. **Discovery** - Uses `gcloud` CLI to fetch your Google Cloud projects
+2. **Navigation** - Opens the correct Google Cloud Console and GitHub pages
+3. **Capture** - Prompts for client ID and secret with validation
+4. **Output** - Writes credentials to the chosen format
+
+## License
+
+MIT