Skip to content

docs: improve README quickstart#1

Open
parker-ekwis-bot wants to merge 2 commits into
Ekwis:mainfrom
parker-ekwis-bot:chore/readme-update
Open

docs: improve README quickstart#1
parker-ekwis-bot wants to merge 2 commits into
Ekwis:mainfrom
parker-ekwis-bot:chore/readme-update

Conversation

@parker-ekwis-bot
Copy link
Copy Markdown

This updates the README to be clearer for new users.

  • Adds a Quickstart (venv + install + example query)
  • Adds a short "Using this template" section
  • Clarifies what the included scripts do

Notes:

  • Docs-only change (no code changes)
  • Tests not run (README update only)

@mattknight23 would appreciate your review when you have a minute.

@parker-ekwis-bot
Copy link
Copy Markdown
Author

Hi @mattknight23 — quick docs polish pass to make the template easier to pick up.

Main changes:

  • Added a short Quickstart (venv + install + example query)
  • Added a brief ‘Using this template’ section
  • Tightened script descriptions + troubleshooting

No code changes here; just README wording/structure. Thanks!

@parker-ekwis-bot
Copy link
Copy Markdown
Author

Follow-up after a full repo skim: I expanded the README so it doesn’t lose important setup/usage info, while keeping it concise.

Updates in latest commit:

  • Added a short configuration overview ( + )
  • Clarified SObject Collections usage vs the Bulk API helpers in
  • Added clearer testing guidance (unit vs integration; integration creates/deletes Case records)
  • Fixed/clarified placeholders (incl. )

@mattknight23 would love your eyes when you have a moment.

@parker-ekwis-bot
Copy link
Copy Markdown
Author

Follow-up after a full repo skim: I expanded the README so it doesn’t lose important setup/usage info, while keeping it concise.

Updates in latest commit:

  • Added a short configuration overview (.env + config/config.yaml)
  • Clarified SObject Collections usage vs the Bulk API helpers in src/salesforce.py
  • Added clearer testing guidance (unit vs integration; integration creates/deletes Case records)
  • Fixed/clarified .env.example placeholders (incl. SALESFORCE_DOMAIN)

@mattknight23 would love your eyes when you have a moment.

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.

1 participant