Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Cox committed May 11, 2018
1 parent ba5bf9e commit 4cf68a0
Showing 1 changed file with 69 additions and 61 deletions.
130 changes: 69 additions & 61 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,17 @@
* Color
* Clear Formatting
* Code
* Table
* Link
* Image
* Audio
* Video
* Ordered List
* Unordered List
* Indent / Outdent
* Heading (H1 - H6)
* Indent
* Outdent
* Justify
* Headings
* Blockquote

## Usage
Expand All @@ -29,80 +32,85 @@
```
<custom-element-demo>
<template>
<link rel="import" href="wysiwyg-e.html">
<link rel="import" href="tools/bold.html">
<link rel="import" href="tools/italic.html">
<link rel="import" href="tools/underline.html">
<link rel="import" href="tools/strike.html">
<link rel="import" href="tools/color.html">
<link rel="import" href="tools/clear.html">
<link rel="import" href="tools/code.html">
<link rel="import" href="tools/link.html">
<link rel="import" href="tools/image.html">
<link rel="import" href="tools/audio.html">
<link rel="import" href="tools/video.html">
<link rel="import" href="tools/ordered.html">
<link rel="import" href="tools/unordered.html">
<link rel="import" href="tools/indent.html">
<link rel="import" href="tools/outdent.html">
<link rel="import" href="tools/justify.html">
<link rel="import" href="tools/heading.html">
<link rel="import" href="tools/blockquote.html">
<wysiwyg-e style="width: 100vw; height: 100vh;">
<wysiwyg-tool-bold></wysiwyg-tool-bold>
<wysiwyg-tool-italic></wysiwyg-tool-italic>
<wysiwyg-tool-underline></wysiwyg-tool-underline>
<wysiwyg-tool-strike></wysiwyg-tool-strike>
<wysiwyg-tool-color></wysiwyg-tool-color>
<wysiwyg-tool-clear></wysiwyg-tool-clear>
<wysiwyg-tool-code></wysiwyg-tool-code>
<wysiwyg-tool-link></wysiwyg-tool-link>
<wysiwyg-tool-image></wysiwyg-tool-image>
<wysiwyg-tool-audio></wysiwyg-tool-audio>
<wysiwyg-tool-video></wysiwyg-tool-video>
<wysiwyg-tool-ordered></wysiwyg-tool-ordered>
<wysiwyg-tool-unordered></wysiwyg-tool-unordered>
<wysiwyg-tool-indent></wysiwyg-tool-indent>
<wysiwyg-tool-outdent></wysiwyg-tool-outdent>
<wysiwyg-tool-justify right center full></wysiwyg-tool-justify>
<wysiwyg-tool-heading h1 h2 h3 h4 h5 h6></wysiwyg-tool-heading>
<wysiwyg-tool-blockquote></wysiwyg-tool-blockquote>
</wysiwyg-e>
<script src="../../@webcomponents/webcomponentsjs/webcomponents-loader.js" async></script>
<script src="../../web-animations-js/web-animations-next-lite.min.js" async></script>
<script type="module" src="../wysiwyg-e.js"async></script>
<script type="module" src="../tools/bold.js" async></script>
<script type="module" src="../tools/italic.js" async></script>
<script type="module" src="../tools/underline.js" async></script>
<script type="module" src="../tools/strike.js" async></script>
<script type="module" src="../tools/color.js" async></script>
<script type="module" src="../tools/clear.js" async></script>
<script type="module" src="../tools/code.js" async></script>
<script type="module" src="../tools/table.js" async></script>
<script type="module" src="../tools/link.js" async></script>
<script type="module" src="../tools/image.js" async></script>
<script type="module" src="../tools/audio.js" async></script>
<script type="module" src="../tools/video.js" async></script>
<script type="module" src="../tools/ordered.js" async></script>
<script type="module" src="../tools/unordered.js" async></script>
<script type="module" src="../tools/indent.js" async></script>
<script type="module" src="../tools/outdent.js" async></script>
<script type="module" src="../tools/justify.js" async></script>
<script type="module" src="../tools/heading.js" async></script>
<script type="module" src="../tools/blockquote.js" async></script>
<wysiwyg-e style="width: 100vw; height: 100vh;" id="wysiwygE">
<wysiwyg-tool-bold></wysiwyg-tool-bold>
<wysiwyg-tool-italic></wysiwyg-tool-italic>
<wysiwyg-tool-underline></wysiwyg-tool-underline>
<wysiwyg-tool-strike></wysiwyg-tool-strike>
<wysiwyg-tool-color></wysiwyg-tool-color>
<wysiwyg-tool-clear></wysiwyg-tool-clear>
<wysiwyg-tool-code></wysiwyg-tool-code>
<wysiwyg-tool-table></wysiwyg-tool-table>
<wysiwyg-tool-link></wysiwyg-tool-link>
<wysiwyg-tool-image></wysiwyg-tool-image>
<wysiwyg-tool-audio></wysiwyg-tool-audio>
<wysiwyg-tool-video></wysiwyg-tool-video>
<wysiwyg-tool-ordered></wysiwyg-tool-ordered>
<wysiwyg-tool-unordered></wysiwyg-tool-unordered>
<wysiwyg-tool-indent></wysiwyg-tool-indent>
<wysiwyg-tool-outdent></wysiwyg-tool-outdent>
<wysiwyg-tool-justify allow-right allow-center allow-full></wysiwyg-tool-justify>
<wysiwyg-tool-heading allow-h1 allow-h2 allow-h3 allow-h4 allow-h5 allow-h6></wysiwyg-tool-heading>
<wysiwyg-tool-blockquote></wysiwyg-tool-blockquote>
</wysiwyg-e>
</template>
</custom-element-demo>
```
-->
```html
<wysiwyg-e>
<wysiwyg-tool-bold></wysiwyg-tool-bold>
<wysiwyg-tool-italic></wysiwyg-tool-italic>
<wysiwyg-tool-underline></wysiwyg-tool-underline>
<wysiwyg-tool-strike></wysiwyg-tool-strike>
<wysiwyg-tool-color></wysiwyg-tool-color>
<wysiwyg-tool-clear></wysiwyg-tool-clear>
<wysiwyg-tool-code></wysiwyg-tool-code>
<wysiwyg-tool-link></wysiwyg-tool-link>
<wysiwyg-tool-image></wysiwyg-tool-image>
<wysiwyg-tool-audio></wysiwyg-tool-audio>
<wysiwyg-tool-video></wysiwyg-tool-video>
<wysiwyg-tool-ordered></wysiwyg-tool-ordered>
<wysiwyg-tool-unordered></wysiwyg-tool-unordered>
<wysiwyg-tool-indent></wysiwyg-tool-indent>
<wysiwyg-tool-outdent></wysiwyg-tool-outdent>
<wysiwyg-tool-justify right center full></wysiwyg-tool-justify>
<wysiwyg-tool-heading h1 h2 h3 h4 h5 h6></wysiwyg-tool-heading>
<wysiwyg-tool-blockquote></wysiwyg-tool-blockquote>
<wysiwyg-tool-bold></wysiwyg-tool-bold>
<wysiwyg-tool-italic></wysiwyg-tool-italic>
<wysiwyg-tool-underline></wysiwyg-tool-underline>
<wysiwyg-tool-strike></wysiwyg-tool-strike>
<wysiwyg-tool-color></wysiwyg-tool-color>
<wysiwyg-tool-clear></wysiwyg-tool-clear>
<wysiwyg-tool-code></wysiwyg-tool-code>
<wysiwyg-tool-table></wysiwyg-tool-table>
<wysiwyg-tool-link></wysiwyg-tool-link>
<wysiwyg-tool-image></wysiwyg-tool-image>
<wysiwyg-tool-audio></wysiwyg-tool-audio>
<wysiwyg-tool-video></wysiwyg-tool-video>
<wysiwyg-tool-ordered></wysiwyg-tool-ordered>
<wysiwyg-tool-unordered></wysiwyg-tool-unordered>
<wysiwyg-tool-indent></wysiwyg-tool-indent>
<wysiwyg-tool-outdent></wysiwyg-tool-outdent>
<wysiwyg-tool-justify allow-right allow-center allow-full></wysiwyg-tool-justify>
<wysiwyg-tool-heading allow-h1 allow-h2 allow-h3 allow-h4 allow-h5 allow-h6></wysiwyg-tool-heading>
<wysiwyg-tool-blockquote></wysiwyg-tool-blockquote>
</wysiwyg-e>
```

## Installation

``bower install wysiwyg-e``
``npm install wysiwyg-e``

## License

### The MIT License (MIT)
Copyright (c) 2017 Jonathan Cox
Copyright (c) 2018 Jonathan Cox

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down

0 comments on commit 4cf68a0

Please sign in to comment.