Update README.md to enhance project description and clarify usage instructions (create-vertex-app)

[Codebmk]

Summary of Changes (What does this PR do?)

• Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Status of maturity (all need to be checked before merging):

• I've tested this locally
• I consider this code done
• This change ready to hit production in its current state
• The title of the PR states what changed and the related issues number (used for the release note).
• I've included issue number in the "Closes #ISSUE-NUMBER" part of the "What are the relevant tickets?" section to link the issue.
• I've updated corresponding documentation for the changes in this PR.
• I have written unit and/or e2e tests for my change(s).

How should this be manually tested?

• Please include the steps to be done inorder to setup and test this PR.

What are the relevant tickets?

• Closes #
• Jira_card_number (If exists)

Screenshots (optional)

Summary by CodeRabbit

• Documentation
  • Updated create-vertex-app documentation to describe general-purpose IoT dashboard generation.
  • Added interactive prompt guidance and non-interactive usage examples.
  • Added instructions for customizing generated configuration.
  • Added contribution and MIT license information.
• Release
  • Published create-vertex-app version 0.1.4.
  • Updated the changelog with the 0.1.4 release details.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1ec3cc96-e6a3-4b25-b7f3-f6849d23984b

📥 Commits

Reviewing files that changed from the base of the PR and between 2efc1e4 and a75458b.

⛔ Files ignored due to path filters (1)

• packages/create-vertex-app/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• packages/create-vertex-app/CHANGELOG.md
• packages/create-vertex-app/README.md
• packages/create-vertex-app/package.json

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/create-vertex-app/README.md

---

📝 Walkthrough

Walkthrough

The PR updates create-vertex-app documentation and release metadata. The README now describes a general IoT dashboard generator and its usage flow. The package version and changelog now show version 0.1.4.

Changes

create-vertex-app update

Layer / File(s)	Summary
README usage and project documentation packages/create-vertex-app/README.md	The README updates the project description, usage examples, prompt flow, configuration guidance, contribution information, and license information.
Package release metadata packages/create-vertex-app/CHANGELOG.md, packages/create-vertex-app/package.json	The changelog records version 0.1.4 dated 2026-08-02. The package version changes from 0.1.0 to 0.1.4.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

• airqo-platform/AirQo-frontend#3805: Updates documentation, changelog, and version metadata for the same create-vertex-app CLI.

Suggested reviewers: baalmart

Poem

A dashboard guide takes clearer form,
New commands state the setup norm.
Version numbers now align,
Release notes mark the date and sign.
The package ships with docs in line.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the primary README updates, which are the main focus of the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix-package-readme

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/create-vertex-app/README.md`:
- Around line 20-26: Update the interactive setup description in the README to
mention all prompts, including organization name, color, map selection, Short
name, and whether to initialize a git repository; alternatively, describe the
prompts generically as several questions to avoid listing an incomplete flow.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 51857144-2d28-41c1-aa7c-add544e4ff3a

📥 Commits

Reviewing files that changed from the base of the PR and between 3f1bdff and 2efc1e4.

📒 Files selected for processing (1)

• packages/create-vertex-app/README.md

[Copilot]

🟡 Not ready to approve

The README now includes scripted flags without documenting them, and the version bump appears inconsistent with the shipped changelog content.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Pull request overview

This PR updates the @airqo/create-vertex-app package documentation to better describe the scaffolded dashboard’s purpose and streamlines usage guidance, alongside a patch version bump for the CLI package.

Changes:

• Rewrote packages/create-vertex-app/README.md to broaden the project description and simplify usage examples, adding contribution/license sections.
• Removed the detailed non-interactive flags table while keeping a non-interactive example command.
• Bumped @airqo/create-vertex-app from 0.1.0 to 0.1.3 (and synced the lockfile).

File summaries

File	Description
packages/create-vertex-app/README.md	Updates project description and reorganizes/simplifies usage + contribution/license sections.
packages/create-vertex-app/package.json	Bumps CLI package version to 0.1.3.
packages/create-vertex-app/package-lock.json	Syncs lockfile version metadata with the package bump.

Review details

Files not reviewed (1)

• packages/create-vertex-app/package-lock.json: Generated file

• Files reviewed: 2/3 changed files
• Comments generated: 2
• Review effort level: Lite

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

[Codebmk]

skipping suggestion