Skip to content

feat(docs): add alternative installation methods to README #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

crStiv
Copy link

@crStiv crStiv commented Apr 28, 2025

📝 Description

Added "Get Started" section to the README with alternative installation methods beyond Homebrew:

  • Building from source with complete step-by-step instructions
  • Using pre-built binaries from GitHub releases with platform-specific commands
  • Maintained consistent style with the existing documentation

✅ Solved Issues

Resolves #62

🔄 Change

  • ✨ New feature (e.g. API route, major perf improvement...)
  • 🐛 Bug fix
  • 🧹 Chore (e.g. package upgrades, configuration change, refactor, small perf improvement, typos...)
  • 🧪 Tests
  • 🏭 DevOps (e.g. CI-CD, development environment upgrade, security upgrade, automation addition...)
  • 📚 Documentation
  • 💥 Breaking Change

💥 Breaking Change (if applicable)

📋 Checklist

  • I have added tests to cover my changes, if applicable.
  • I have updated relevant documentation for my changes.
  • I have included references to issues resolved by this Pull Request
  • I have set a Pull Request title that respects gitmoji
  • I have set a Pull Request's label to one of type.feat,type.fix,type.chore,type.test,type.docs,type.devops
  • I have set a Pull Request's label to one of breaking-change or non-breaking-change
  • I have documented breaking changes and migration path, if applicable

📓 Additional Notes

@crStiv crStiv requested a review from nmvalera as a code owner April 28, 2025 14:07
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.

dev: add zk-pig get started section in readme for other methods than homebrew
1 participant