Skip to content

normalized readme #2

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.

Sign up for GitHub

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

Open
atordvairn wants to merge 4 commits into
base: master
Choose a base branch
from
Open

normalized readme #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d2d56a
'normalised' readme
atordvairn Feb 6, 2022
8b5e38d
removed .js cause it wasn't there at the first place
atordvairn Feb 6, 2022
8f4c979
formatted source code
atordvairn Feb 6, 2022
3c60bcf
formatted test files
atordvairn Feb 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
normalize
=========

Turn ugly
```
## Normalize
Turn ugly
``` html
<p>
<b>
hi
Expand All @@ -14,8 +12,8 @@ Turn ugly
</i>
</p>
```
into beautiful
```
into beautiful ✨
``` html
<p>
<b>
hi
Expand All @@ -26,12 +24,20 @@ into beautiful
</p>
```
With just a touch of
```
``` javascript
normalize(element, config);
```
Where config is optional, having pleasant defaults, but extendable for your amusement.
Where config is optional, having pleasant defaults, but extendable for your amusement!

## Installation
``` html
<!-- add jQuery -->
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<!-- then normalise -->
<script src="https://cdn.jsdelivr.net/gh/amark/normalize@master/normalize.js"></script>
```

##API
## API
Docs coming soon! Peruse the source for now, it is decently tiny, and the built in config explains most of it.
Depends upon the delightful jQuery.

Expand Down
Loading