Skip to content

Describe the product, its status and its license in the README - #6

Open
masaok wants to merge 1 commit into
analyzersfrom
readme
Open

Describe the product, its status and its license in the README#6
masaok wants to merge 1 commit into
analyzersfrom
readme

Conversation

@masaok

@masaok masaok commented Oct 2, 2026

Copy link
Copy Markdown
Owner

Why

The repository description and website now say what the product is: find forgotten cloud spend, with ranked savings and the exact fix. The README said what the packages hold but not what the product is for, and it did not link to costexplorer.net.

Scope

README.md only.

  • Opens with the tagline and a link to costexplorer.net, and says findings are ranked by monthly saving with evidence, confidence and the fix.
  • Says the engine is read-only, and that the product is independent of AWS and is not the AWS billing tool of the same name.
  • Adds a Status section with what exists today: one rule (aws.ebs.unattached), AWS first with GCP to follow, and no command-line tool yet. It links to "Add an analyzer" in CONTRIBUTING.md.
  • Puts the package table under a Layout heading and adds a License section.

The website shows npx costexplorer scan. The README does not, because that command is not in this repository yet.

The License section names Apache-2.0 without a link, because LICENSE arrives in #3 and pnpm check rejects a link to a file that is not on this branch.

Stacked on #5.

Verification

VERIFIED. pnpm verify on Node 24.19.0 ran every step through the smoke test.

PASS feature-map (2 surfaces in code, 2 rows)
PASS docs-links (31 relative links in 11 markdown files)
PASS versions (Node 24, 2 workflow files)
ℹ tests 13
ℹ pass 13
ℹ fail 0
 Test Files  8 passed (8)
      Tests  43 passed (43)
Statements   : 100% ( 82/82 )
✓ Compiled successfully in 3.1s
PASS GET / 200, text "To get started, edit the"
PASS GET /favicon.ico 200, type "image/x-icon"
2 surfaces requested, 0 failures

https://claude.ai/code/session_01V9SuCtJwBiEwq9SyM7eJki

@masaok
Describe the product, its status and its license in the README
58701cb 
The README said what the packages hold but not what the product is for.
It now opens with the tagline and a link to costexplorer.net, says the
engine is read-only and independent of AWS, and states what exists today:
one rule and no command-line tool yet.

Claude-Session: https://claude.ai/code/session_01V9SuCtJwBiEwq9SyM7eJki
Copilot AI balanced review requested due to automatic review settings October 2, 2026 19:10
@vercel

vercel Bot commented Oct 2, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
costexplorer Ready Ready Preview Oct 2, 2026 7:10pm UTC

Request Review

Copilot AI reviewed Oct 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

This branch was successfully deployed

1 active deployment
Preview — 58701cbe Deployed Oct 2, 2026 by vercel[bot]
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@masaok