docs: add Quick Start guide#15
Open
Arvuno wants to merge 2 commits into
Open
Conversation
- Change 'pip install agentmail-python' to 'pip install agentmail' (correct package name) - Replace 'python setup.py install' with 'pip install -e .' (proper method) Based on cubic-dev-ai bot review feedback.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Quick Start section to the README with basic installation and usage instructions.
Changes
agentmail-python→agentmail(correct PyPI package name)python setup.py install→pip install -e .PR Feedback Response
pip install agentmail-pythontopip install agentmail(correct package name on PyPI)python setup.py installtopip install -e .(proper Python package installation)Thanks to the reviewer for catching these issues!
Summary by cubic
Adds a Quick Start guide to the README with correct install steps for the
agentmailpackage. Clarifies install via PyPI (pip install agentmail) or local editable install (pip install -e .).Written for commit a14aef4. Summary will update on new commits.