Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve README #16

Open
nicobrenner opened this issue Mar 8, 2024 · 1 comment
Open

Improve README #16

nicobrenner opened this issue Mar 8, 2024 · 1 comment
Assignees
@nicobrenner
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@nicobrenner
Copy link
Owner

Following Hatchet's structure: https://github.com/hatchet-dev/hatchet

Command Jobs' should be something like:

  • What is Command Jobs?
  • What Makes Command Jobs Great?
    • Command line interface
    • Local data (don't need to share with saas provider)
    • Example use cases
  • Quickstart
  • How does this compare to alternatives (LinkedIn, Monster, Indeed)?
  • Configuration
    ...
@nicobrenner nicobrenner added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 8, 2024
@nicobrenner nicobrenner self-assigned this Mar 8, 2024
@nicobrenner
Copy link
Owner Author

Slowly chipping at this

  • There's more content now, including the Updates section
  • The README is up to date with the latest changes
  • Just added an explanation about COMMANDJOBS_LISTINGS_PER_BATCH

nicobrenner added a commit that referenced this issue Mar 12, 2024
@nicobrenner
Move images from base of repo to doc folder. This can be considered a…
3ef0a68 
…s contributing to cleaning up the README (#16)
@nicobrenner nicobrenner mentioned this issue Mar 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nicobrenner nicobrenner

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nicobrenner