Add missing JS files from gem build & add notes on MediaUploader

patricklindsay · patricklindsay · commit 6e5ec7894b1d · 2021-03-16T17:02:15.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,7 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 ### Fixed
 -
 
-## v0.1.0 - 2021-03-16
+## v0.1.2 - 2021-03-16
 
 ### Added
 - Initial release
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    block_editor (0.1.0)
+    block_editor (0.1.2)
       rails (~> 6.0)
       webpacker (~> 5.1)
 
diff --git a/README.md b/README.md
@@ -50,6 +50,11 @@ end
 ```
 * Boom! You have a Block Editor linked to your model
 
+Note: If the error `Webpacker::Manifest::MissingEntryError` appears you need to run the following command to precompile the BlockEditor assets;
+```
+rails block_editor:webpacker:compile
+```
+
 ### Strong Parameters
 Remember to permit the block list attributes if you're using Strong Parameters (you should be), i.e;
 ```
@@ -80,6 +85,15 @@ The below files should be overridden within your application in order to style y
 * `app/assets/stylesheets/block_editor/frontend/blocks.scss` - Any styles that should be displayed within the frontend and backend
 * `app/assets/stylesheets/block_editor/backend/blocks.scss` - Any styles that should _only_ be displayed within the block editor itself, i.e when creating or editing the blocks
 
+### MediaUploader & Images
+There is no built in MediaUploader or media gallery, it is up to the host application to implement this.
+
+When the media uploader is requested the Block Editor checks if `window.MediaUploader` is defined. If it is defined the block editor will call `window.MediaUploader.open(callback)`, otherwise it will randomly select an image from [Unsplash](https://unsplash.com)
+
+When an image is successfully uploaded or selected the MediaUploader instance should call the callback which was passed into the `open` function;
+```
+callback({url: imageUrl})
+```
 
 ### Turbolinks
 Currently Block Editor is not compatible with Turbolinks as history is only being reset on full page loads. To disable Turbolinks per page add the following in your layout view file within your `<HEAD>`;;
diff --git a/block_editor.gemspec b/block_editor.gemspec
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/yamasolutions/block-editor"
   spec.metadata["changelog_uri"] = "https://github.com/yamasolutions/block-editor/blob/master/CHANGELOG.md"
 
-  spec.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+  spec.files = Dir["{app,bin,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "package.json", "yarn.lock", "postcss.config.js"]
 
   spec.add_dependency "rails", "~> 6.0"
   spec.add_dependency 'webpacker', '~> 5.1'
diff --git a/lib/block_editor/version.rb b/lib/block_editor/version.rb
@@ -1,3 +1,3 @@
 module BlockEditor
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).`
`14`	`14`	`### Fixed`
`15`	`15`	`-`
`16`	`16`
`17`		`-## v0.1.0 - 2021-03-16`
	`17`	`+## v0.1.2 - 2021-03-16`
`18`	`18`
`19`	`19`	`### Added`
`20`	`20`	`- Initial release`