docs: improve README with setup instructions

[Aiyaret-Sandhu]

This pull request updates the README.md file to improve clarity and correctness of the setup instructions.

Changes Made

• Removed outdated or incorrect installation instructions.
• Added correct steps for setting up the project via Docker using a configuration file.
• Included a complete sample my-config.json.
• Added a note specifying Ubuntu LTS (20.04 or later) as the preferred OS.

Summary by CodeRabbit

• Documentation
  • Updated instructions for running the REST API using the Credo Controller repository and Docker images.
  • Added detailed setup methods including local development, building, and using prebuilt Docker images with PostgreSQL.
  • Recommended Ubuntu LTS (20.04 or later), Node.js 18.19.0, and Yarn for development.
  • Provided explicit guidance on JSON configuration files and PostgreSQL wallet connection parameters.
  • Clarified WebSocket and webhook usage with improved wording and formatting.

[coderabbitai[bot]]

Walkthrough

The README.md documentation was updated to replace references to the Aries Framework JavaScript REST API with the Credo Controller REST API. It introduces multiple detailed setup methods including local development, building and running Docker images, and using prebuilt images with PostgreSQL. Configuration guidance now emphasizes JSON config files and updated connection parameters. No code or exported entities were changed.

Changes

Cohort / File(s)	Change Summary
Documentation update README.md	Replaced Aries Framework JS REST API references with Credo Controller REST API; restructured quick start into multiple detailed setup methods; updated OS and Node.js recommendations; replaced simple Docker run with cloning and running Credo Controller repo; emphasized JSON config file usage and PostgreSQL wallet connection details; minor wording and formatting improvements throughout.

Poem

🐇
A README refreshed, so clear and bright,
With Docker commands set just right.
A config file now leads the way,
On Ubuntu LTS, you'll code all day.
From old to new, instructions flow—
The rabbit hops where changes grow!

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[GHkrishna]

@Aiyaret-Sandhu Do you mind having a look at the failing DCOs

[Aiyaret-Sandhu]

@GHkrishna I have looked at the DCOs and will correct them, please review my replies to your queries and confirm if i should proceed with the changes.

[GHkrishna]

confirm if i should proceed with the changes

Yes sure, I've addressed those comments

[sonarqubecloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[GHkrishna]

I think this PR looks good to me. However, I'll need to check for the last statements regarding startServer and setupServer

[ajile-in]

@Aiyaret-Sandhu I think commits do not have verifier signatures. Can you please fix them? @GHkrishna may be able to guide you.

[GHkrishna]

I think commits do not have verifier signatures.

I'm not really sure why the verified mark won't show up here, but as per the DCO, the commits are signed. So we won't be needing to worry about signing them again