Skip to content
Browse files

updates gems and readme.

  • Loading branch information...
1 parent ceaf62e commit 932c870f655834652675669470da46fb804d0efb @jejacks0n committed Apr 6, 2013
Showing with 50 additions and 21 deletions.
  1. +38 −11 Gemfile.lock
  2. +12 −10 README.md
View
49 Gemfile.lock
@@ -34,6 +34,15 @@ GEM
multi_json (~> 1.0)
arel (3.0.2)
builder (3.0.4)
+ capybara (2.0.3)
+ mime-types (>= 1.16)
+ nokogiri (>= 1.3.3)
+ rack (>= 1.0.0)
+ rack-test (>= 0.5.4)
+ selenium-webdriver (~> 2.0)
+ xpath (~> 1.0.0)
+ childprocess (0.3.9)
+ ffi (~> 1.0, >= 1.0.11)
coderay (1.0.9)
coffee-rails (3.2.2)
coffee-script (>= 2.2.0)
@@ -43,8 +52,12 @@ GEM
execjs
coffee-script-source (1.4.0)
erubis (2.7.0)
+ eventmachine (1.0.3)
execjs (1.4.0)
multi_json (~> 1.0)
+ faye-websocket (0.4.7)
+ eventmachine (>= 0.12.0)
+ ffi (1.6.0)
guard (1.6.2)
listen (>= 0.6.0)
lumberjack (>= 1.0.2)
@@ -62,7 +75,8 @@ GEM
haml (>= 3.1, < 4.1)
railties (>= 3.1, < 4.1)
hike (1.2.1)
- i18n (0.6.1)
+ http_parser.rb (0.5.3)
+ i18n (0.6.4)
journey (1.0.4)
json (1.7.7)
listen (0.7.3)
@@ -73,11 +87,15 @@ GEM
treetop (~> 1.4.8)
method_source (0.8.1)
mime-types (1.21)
- multi_json (1.6.1)
+ multi_json (1.7.2)
+ nokogiri (1.5.9)
open4 (1.3.0)
- phantomjs-mac (0.0.3)
- phantomjs.rb (0.0.5)
- phantomjs-mac
+ phantomjs (1.8.1.1)
+ poltergeist
+ poltergeist (1.1.0)
+ capybara (~> 2.0, >= 2.0.1)
+ faye-websocket (~> 0.4, >= 0.4.4)
+ http_parser.rb (~> 0.5.3)
polyglot (0.3.3)
pry (0.9.12)
coderay (~> 1.0.5)
@@ -105,35 +123,44 @@ GEM
rake (>= 0.8.7)
rdoc (~> 3.4)
thor (>= 0.14.6, < 2.0)
- rake (10.0.3)
+ rake (10.0.4)
rb-fsevent (0.9.3)
- rdoc (3.12.1)
+ rdoc (3.12.2)
json (~> 1.4)
+ rubyzip (0.9.9)
sass (3.2.6)
sass-rails (3.2.6)
railties (~> 3.2.0)
sass (>= 3.1.10)
tilt (~> 1.3)
+ selenium-webdriver (2.31.0)
+ childprocess (>= 0.2.5)
+ multi_json (~> 1.0)
+ rubyzip
+ websocket (~> 1.0.4)
slop (3.4.3)
sprockets (2.2.2)
hike (~> 1.2)
multi_json (~> 1.0)
rack (~> 1.0)
tilt (~> 1.1, != 1.3.0)
- teabag (0.6.0)
- phantomjs.rb (~> 0.0.5)
+ teabag (0.7.0)
+ phantomjs (>= 1.8.1.1)
railties (>= 3.2.5, < 5)
terminal-notifier-guard (1.5.3)
terminal-table (1.4.5)
- thor (0.17.0)
- tilt (1.3.3)
+ thor (0.18.1)
+ tilt (1.3.6)
treetop (1.4.12)
polyglot
polyglot (>= 0.3.1)
tzinfo (0.3.35)
uglifier (1.3.0)
execjs (>= 0.3.0)
multi_json (~> 1.0, >= 1.0.2)
+ websocket (1.0.7)
+ xpath (1.0.0)
+ nokogiri (~> 1.3)
yui-compressor (0.9.6)
POpen4 (>= 0.1.4)
View
22 README.md
@@ -5,12 +5,12 @@ Mercury2 is a WYSIWYG editor, and takes a different approach than any editor out
Regions dictate toolbars, buttons, and what actions they support. This simplifies the configuration for toolbars, but also provides more flexibility in terms of defining your own custom functionality that doesn't fit into the standard Mercury features. Check out the gallery region for an example of this.
-Mercury2 allows sandboxing content within an iframe or it can load directly on the page you're editing. This has been a complication in the past, so this version simplifies that while also retaining the ability to sandbox itself to mimimize conflicts with javascript libraries and css.
+Mercury2 allows sandboxing content within an iframe or it can load directly on the page you're editing. This has been a complication in the past, so this version simplifies that while also retaining the ability to sandbox itself to mimimize conflicts with javascript libraries and css. It also supports moving it's interface into a [Shadow DOM](http://glazkov.com/2011/01/14/what-the-heck-is-shadow-dom), which removes the interface from the dom on the page that you're editing, which helps to alleviate conflicts on the page with other javascript and css, but isn't as reliable as using an iframe.
## Developer Notice
-This branch represents the future version of Mercury Editor. This iteration of Mercury Editor (Mercury2) will separate the Rails portions from the Javascript portions of the project. Rails is still used for development (for a server, coffeescript, sass, build process etc.) but the Rails Engine will be broken off into a different project so that more functionality can be added, and to serve as an example of how to implement functionality like snippets and image uploading.
+This branch represents the future version of Mercury Editor. This iteration of Mercury Editor (Mercury2) separates the Rails portions from the Javascript portions of the project. Rails is still used for development (for a server, coffeescript, sass, build process etc.) but the Rails Engine has been moved to [mercury-rails] -- this enables more functionality, and to serve as an example of how to implement functionality like snippets and image uploading. If you're interested in integrating Mercury with your own platform, this is the best place to start.
## Fonts & Graphics
@@ -19,14 +19,12 @@ Mercury uses two custom fonts for all graphic elements in the interface. This al
The primary toolbar icons and general interface elements are in mercury.ttf, which is generated using the awesome [IcoMoon project](http://icomoon.io/app/) (by [Keyamoon](https://twitter.com/keyamoon)). You can upload/import the mercury.dev.svg file that can be found in the project and add new icons for your custom buttons. If you're making a plugin you probably want to bundle these separately.
-The toolbar icons (bold, italics, etc.) are in toolbars.ttf, and was built using [fontstruct.com](http://fontstruct.com/). [The original font](http://fontstruct.com/fontstructions/show/797530) can be cloned and edited as needed. Fontstruct is used here because it allows for small pixel fonts but also allows for more advanced shapes.
+The toolbar icons (bold, italics, etc.) are in toolbars.ttf, and was built using [fontstruct.com](http://fontstruct.com/). [The original font](http://fontstruct.com/fontstructions/show/797530) can be cloned and edited as needed. Fontstruct is used here because it allows for small pixel fonts but also allows for more advanced shape that scale nicely.
## Internationalization / Translations
-Mercury has support for the following locales. If you'd like to contribute one, the easiest way is to fork the project,
-create a locale file with your translation, and submit a pull request -- that way you get full credit for your
-contributions.
+Mercury has support for the following locales. If you'd like to contribute one, the easiest way is to fork the project, create a locale file with your translation, and submit a pull request -- that way you get full credit for your contributions.
Translations and contributors:
- Arabic ([mohamagdy](https://github.com/mohamagdy))
@@ -47,7 +45,7 @@ Translations and contributors:
## Dependencies
-This version of Mercury is being built using jQuery 2.0, but attempts to minimize reliance on jQuery as much as is feasible, and near the end there may be a pass to remove things like $.extend. Selections in HTML regions are handled using Rangy. Check `lib/javascripts/mercury/dependencies.coffee` for a full list of dependencies.
+This version of Mercury is being built using jQuery 2.0, but attempts to minimize reliance on jQuery as much as is feasible, and near the end there may be a pass to remove things like $.extend. Selections in HTML regions are handled using Rangy. Each region can also have it's own dependencies, which is entirely up to the author. If you're writing a custom region it's expected to document the dependencies and version information. Check `lib/javascripts/mercury/dependencies.coffee` for a full list of dependencies.
## Development
@@ -65,7 +63,7 @@ bundle install
Run specs / build distro on passing specs
```shell
-rake
+bundle exec rake
```
Run specs with coverage reports
@@ -105,12 +103,16 @@ Mercury.trigger('action', 'direction')
#### Webkit
-- Dropping files at the cursor position in textarea doesn't work.
+- Dropping files at the cursor position doesn't work.
#### Gecko
- Dropping files doesn't display cursor position, and thus dropping at that place isn't applicable.
-- The drop indicator doesn't like to stay visible (we could fix this by using dragover).
+
+
+## Consulting
+
+I'm available for hire. If you need help implementing, enhancing, or integrating Mercury Editor this might be a worth while option. I don't always have time for freelance work, so I recommend [Mode Set](http://modeset.com), a small consultancy with amazing folks where I work -- many of the developers there are familiar with Mercury, and it's easier for me to dedicate my days to your issues rather than my evenings.
## License

0 comments on commit 932c870

Please sign in to comment.
Something went wrong with that request. Please try again.