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

Add basic documentation to README #25

Open
PragTob opened this issue Apr 26, 2018 · 2 comments
Open

Add basic documentation to README #25

PragTob opened this issue Apr 26, 2018 · 2 comments
Milestone

Comments

@PragTob
Copy link

PragTob commented Apr 26, 2018

👋

The README is rather... empty. :) Of course you can go to the trailblazer README and eventually find the main documentation but at least a basic usage example like the trailblazer README (preferably more) and a link to the online docs would be nice - so that people who want to use it independently from trailblazer have all the chances.

Thanks and thanks for all your work,
Tobi

@apotonick apotonick added this to the 2.1 milestone Nov 22, 2018
@johannesluedke
Copy link
Contributor

Also there is no docu how to execute the tests locally

@panSarin
Copy link
Collaborator

New documentation about 2.1 and its Operations is there: https://2019.trailblazer.to/2.1/docs/operation.html

We will gather feedback and update README in repo. Also if you would be so kind to propose some PR with some changes in README that you think would be usefull - it would be cool!

Also: join us on zulipchat so we can discuss all ideas/problems and gather more feedback from you! https://trailblazer.zulipchat.com/join/od4yhihn6tra3ix39u4gks72/

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

No branches or pull requests

4 participants