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

Readme enhancements #9350

Merged
merged 2 commits into from
Apr 23, 2018
Merged

Readme enhancements #9350

merged 2 commits into from
Apr 23, 2018

Conversation

pamil
Copy link
Contributor

@pamil pamil commented Apr 18, 2018

Q A
Branch? 1.0
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Related tickets -
License MIT
  • Removed badges (as they happen not to load quite often).
  • Updated our headline.
  • Replaced hardcoded snippets with references to documentation.
  • Made readme shorter and easier to follow.

@pamil pamil added Enhancement Minor issues and PRs improving the current solutions (optimizations, typo fixes, etc.). Documentation Documentation related issues and PRs - requests, fixes, proposals. labels Apr 18, 2018
@pamil pamil added this to the 1.0 milestone Apr 18, 2018
@pamil pamil requested a review from CoderMaggie April 18, 2018 10:10
</a>
<a href="https://scrutinizer-ci.com/g/Sylius/Sylius/" title="Scrutinizer" target="_blank">
<img src="https://img.shields.io/scrutinizer/g/Sylius/Sylius.svg" />
</a>
Copy link
Member

Choose a reason for hiding this comment

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

Maybe they would work if we use Markdown for them?

Build Status
Scrutinizer Code Quality

[![Build Status](https://travis-ci.org/Sylius/Sylius.svg?branch=master)](https://travis-ci.org/Sylius/Sylius)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Sylius/Sylius/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Sylius/Sylius/?branch=master)

I agree it's frustrating to see them failing all the time, but, when working, they look nice and it's an important info about project at the beginning of README :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It generates the same HTML (but without target="_blank").

@Zales0123 Zales0123 merged commit 9dfe395 into Sylius:1.0 Apr 23, 2018
@Zales0123
Copy link
Member

Thank you Kamil!

@pamil pamil deleted the 1.0-readme branch April 23, 2018 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals. Enhancement Minor issues and PRs improving the current solutions (optimizations, typo fixes, etc.).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants