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

First README update with examples #192

Closed
wants to merge 3 commits into from
Closed

First README update with examples #192

wants to merge 3 commits into from

Conversation

muuvmuuv
Copy link

@muuvmuuv muuvmuuv commented Oct 4, 2018

See: #188 and #102

I created this improvement in two hours, so it may not be perfect but should be the first step to improve the README and put some usage examples to the list.

<h1 align="center">
<br>
<a href="https://unibeautify.com/">
<img src="assets/unibeautify-github-icon.png" alt="Unibeautify" width="200">
Copy link
Author

Choose a reason for hiding this comment

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

replace with GitHub CDN

</p>

<p align="center">
<img src="assets/preview.gif" alt="Unibeautify preview GIF">
Copy link
Author

Choose a reason for hiding this comment

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

replace with GitHub CDN

README.md Outdated

We all love to code, that is why we are here – on the earth, no(!) on GitHub – so this tool will make coding even more fun and will improve your work with co-workers, friends and the world of coding!

Unibeautify beautifies your code on-the-fly and that for so [many languages](https://unibeautify.com/docs/languages) that you have to try it and there are plenty of option you can make to customize Unibeautify to your needs. So you can be absolutaly sure everyone who is touching your code, will not break you beautiness!
Copy link
Member

Choose a reason for hiding this comment

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

Some small typos. I also prefer to separate sentences on to multiple lines within Markdown files because it helps with Git diffs.

Consider changing to:

Unibeautify formats your code on-the-fly and supports many languages with plenty of options so you can customize to meet your needs.
You can be confident everyone who is editing your code will leave it looking beautiful!

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for your hard work with the README @muuvmuuv !

At this stage of the project (and since code formatting is still an unfamiliar and optional concern to most developers) I would be more modest about how confident our users can be :) Maybe once code formatting is enforced with a Git hook or continuous integration.

Copy link
Author

Choose a reason for hiding this comment

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

@lassik you are right 😄. Would you mind taking on this passage? It was just a first step to point in a direction. I think a good README is the like the cover of a book. It has to impress on first sight.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Added markdown beautifier
Formatted everything to max line length of 80
@muuvmuuv
Copy link
Author

@Glavin001 any new ideas on this?

README.md Outdated Show resolved Hide resolved
@Glavin001
Copy link
Member

I'll need to review more this week, however, this looks great!
@muuvmuuv feel free to mention me here again if something comes up and I forget to review more.
Awesome work!!! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants