Skip to content

Commit 236057a

Browse files
📖 Readme cleanup
1 parent 026926b commit 236057a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<div align="center" margin="0 auto 20px">
22
<h1>svelte-flex</h1>
33
<p style="font-style: italic;">💪 A reusable flexbox component for Svelte.</p>
4-
<!--
54
<div>
65
<a href='https://travis-ci.org/himynameisdave/svelte-flex'>
76
<img src="https://api.travis-ci.org/himynameisdave/svelte-flex.svg?branch=master" alt="Travis Badge" />
87
</a>
8+
<!--
99
<a href="https://bundlephobia.com/result?p=svelte-flex">
1010
<img src="https://img.shields.io/bundlephobia/min/svelte-flex.svg" alt="Bundle size (minified)" />
1111
</a>
@@ -15,8 +15,8 @@
1515
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fhimynameisdave%2Fsvelte-flex?ref=badge_shield" alt="FOSSA Status">
1616
<img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fhimynameisdave%2Fsvelte-flex.svg?type=shield"/>
1717
</a>
18-
</div>
1918
-->
19+
</div>
2020
</div>
2121

2222
---
@@ -70,9 +70,11 @@ All props are optional (as they all have default values).
7070
[`justify`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content) | `'start'` \| `'center'` \| `'end'` \| `'around'` \| `'between'` \| `'evenly'` | `'center'`
7171
[`reverse`](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction#Result) | `true` \| `false` | `false`
7272

73+
Check out the [test suite](https://github.com/himynameisdave/svelte-flex/blob/026926b4a41234a26607e05a619e2ee9acbf2ebd/src/__tests__/Flex.spec.js#L11) if you're unsure what CSS styles are applied by these props.
74+
7375
### Contributing
7476

75-
Feel free to [file an issue](https://github.com/himynameisdave/svelte-flex/issues/new) or open a pull request.
77+
Feel free to [file an issue](https://github.com/himynameisdave/svelte-flex/issues/new) or open a pull request. Ensure that you add tests for any new functionality.
7678

7779
---
7880

0 commit comments

Comments
 (0)