bastion-rs / bastion

Highly-available Distributed Fault-tolerant Runtime
https://www.bastion-rs.com
Apache License 2.0
2.78k stars 101 forks source link

Improve readme #312

Closed oScape closed 3 years ago

oScape commented 3 years ago

Improve a bit the readme, to join the user to see the example quicker than previously. => https://news.ycombinator.com/item?id=26304568 Even if the first comment exaggerates a bit, I think that putting the examples from the beginning will make it easier to orient new users towards the code and allow them to understand the project more easily.

Stuff around redundancy.

o0Ignition0o commented 3 years ago

care to share a screenshot of the preview? otherwise lgtm :shipit:

Stupremee commented 3 years ago

You can click on "View File" inside the diff

o0Ignition0o commented 3 years ago

yup my bad, it looks great!

oScape commented 3 years ago

@Stupremee you are right about the alignment, it's annoying, but css are not supported: => https://github.community/t/github-flavored-markdown-doesnt-render-css-styles-inside-a-html-block/126258

I will find an other disposition.