Skip to content
New issue

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

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

Already on GitHub? # to your account

docs: update readme #4

Merged
merged 11 commits into from
Apr 17, 2022
Merged

docs: update readme #4

merged 11 commits into from
Apr 17, 2022

Conversation

aakashhemadri
Copy link
Owner

Signed-off-by: Aakash Hemadri aakashhemadri123@gmail.com

@aakashhemadri aakashhemadri added the documentation Improvements or additions to documentation label Apr 16, 2022
@aakashhemadri aakashhemadri added this to the Research & Planning milestone Apr 16, 2022
@aakashhemadri aakashhemadri linked an issue Apr 16, 2022 that may be closed by this pull request
4 tasks
@aakashhemadri aakashhemadri self-assigned this Apr 16, 2022
@aakashhemadri aakashhemadri changed the title docs: add contributer section docs: update readme Apr 16, 2022
Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
* setup env
* run tests
* build binaries

Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
It is necessary to use workflow names in status badge if the workflow
has one. Status badges will not work otherwise

Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
ci: update workflow names to be README.md badge friendly

Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
* add table of contents
* add intro
* change usage to development
* add more badges / currently will not work due to the repo being
  private

Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
Signed-off-by: Aakash Hemadri <aakashhemadri123@gmail.com>
Copy link
Collaborator

@niteshkumar2000 niteshkumar2000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Great!

@aakashhemadri
Copy link
Owner Author

Looks Great!

Once y'all are free, feel free to add your names to the contributor section! Should be a quick and easy pr to get you going here.

@aakashhemadri aakashhemadri merged commit 6670103 into master Apr 17, 2022
@aakashhemadri aakashhemadri deleted the docs branch April 28, 2022 10:44
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README
2 participants