Skip to content

docs: add quickstart guide with HTTP server and Go package examples#27

Merged
akshaydeo merged 1 commit intomainfrom
04-30-fix_quick_setup_in_readme_added
May 6, 2025
Merged

docs: add quickstart guide with HTTP server and Go package examples#27
akshaydeo merged 1 commit intomainfrom
04-30-fix_quick_setup_in_readme_added

Conversation

@Pratham-Mishra04
Copy link
Copy Markdown
Collaborator

Add Quickstart Guide to README

This PR adds a comprehensive quickstart guide to the README, making it easier for new users to get started with Bifrost. The guide includes:

  • Prerequisites section with clear requirements
  • Two main implementation paths:
    • Using Bifrost as an HTTP server (with both Go binary and Docker options)
    • Using Bifrost as a Go package with code examples

The PR also:

  • Reorganizes the README structure to prioritize getting started information
  • Adds utility functions StrPtr() and IntPtr() to the core package
  • Updates code examples to use the new utility functions
  • Improves formatting and readability throughout the documentation
  • Moves the benchmarks section after the getting started section for better flow

These changes make Bifrost more accessible to new users while maintaining all the detailed information for advanced users.

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Pratham-Mishra04 Pratham-Mishra04 force-pushed the 04-30-fix_quick_setup_in_readme_added branch 5 times, most recently from 7623590 to a5308c4 Compare May 1, 2025 11:44
@Pratham-Mishra04 Pratham-Mishra04 force-pushed the 04-30-fix_quick_setup_in_readme_added branch from a5308c4 to 1db6707 Compare May 2, 2025 06:08
@akshaydeo akshaydeo merged commit 831dc8a into main May 6, 2025
1 check passed
@Pratham-Mishra04 Pratham-Mishra04 deleted the 04-30-fix_quick_setup_in_readme_added branch May 6, 2025 04:33
akshaydeo added a commit that referenced this pull request Nov 17, 2025
…dded

docs: add quickstart guide with HTTP server and Go package examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants