Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Initial Readme

  • Loading branch information...
commit e483e27c5b7e4c4ab65ae27ad2bec06559b65d29 1 parent ef52487
@uxder authored
Showing with 36 additions and 3 deletions.
  1. +34 −0 README.md
  2. +1 −1  samples/samples.html
  3. +1 −2  src/vivid.js
View
34 README.md
@@ -0,0 +1,34 @@
+This project is still a work in progress.
+
+#Vivid - A jQuery Html5 Canvas Photo Effects Plugin
+
+##What is Vivid?
+
+Vivid is a jQuery Plugin that transforms an image into a canvas so you can apply filter effects to it.
+Vivid is great because:
+
+- Vivid will maintain the original css applied to your image and transfer it to the canvas.
+- Vivid also has a simple plugin mechanism so you can easily create your own filters.
+- Each filter can also accept its own options
+
+Currently the default the filter is the blackWhite filter which accepts a lightness option.
+
+##How do I use vivid?
+
+Vivid needs to be applied to an image. Set the filter by setting the name in the filter option (or defaults to blackWhite).
+Additionally, set the options of the filter you are applying by adding an object literal with the filter name in. Each plugin
+will have different options.
+
+ $('#someImage').vivid(
+ {
+ filter: 'blackWhite',
+ blackWhite: {
+ lightness: 0.3
+ }
+ }
+ );
+
+
+##How can I help?
+
+If you want to join me on this project, send me a pull request with changes. You can check out the blackWhite filter and use that as a sample to create additional filters.
View
2  samples/samples.html
@@ -27,7 +27,7 @@
<script src="../src/vivid.js"></script>
<script>
$('.vivid').vivid({
- filter: 'blackAndWhite',
+ filter: 'blackWhite',
blackWhite: {
lightness: 0.3
}
View
3  src/vivid.js
@@ -1,8 +1,7 @@
/*
- Radio.js - Chainable, Dependency Free Publish/Subscribe for Javascript
+ Vivid - A jQuery Html5 Canvas Photo Effects Plugin
Author: Scott Murphy 2012
Github: uxder
- Vivid - A jQuery Html5 Canvas Photo Effects Plugin
Version - totally still working this version
Description:
Vivid is a jQuery Plugin that transforms an image into a canvas so you can apply effects to it.
Please sign in to comment.
Something went wrong with that request. Please try again.