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.

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

Updated README.md #307

Merged

Conversation

jeffbulltech
Copy link
Collaborator

@jeffbulltech jeffbulltech commented Nov 13, 2024

Updated README.md with a new format, additional community and support resources as buttons, and included a clearer outline of steps in the Getting Started section to assist with docker deployments.

Pull Request type

  • Bugfix
  • Feature
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • WHOSUSING.md
  • Other (please describe):

NOTE: Please remember to run ./gradlew spotlessApply to fix any format violations.

Changes in this PR

Current README.md is out-of-date and in need of a simpler flow to encourage new developers to review and use Conductor for their workflow needs. Revised the layout of the README.md to match with the current, and most commonly used layout by other popular repo's.
Issue # n/a

Alternatives considered

n/a. Updating the README.md file only.

… and support links as buttons, and included a clearer outline of steps in the Getting Started section to assist with docker deployments.
@jeffbulltech jeffbulltech changed the title Updated READEME.md Updated README.md Nov 13, 2024
@v1r3n v1r3n merged commit 2d19897 into conductor-oss:main Nov 14, 2024
2 checks passed
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