From e3dd315518c0fc2f358c4415fbb4242c85a9cdf0 Mon Sep 17 00:00:00 2001 From: Iuri Matias Date: Sat, 4 Mar 2017 15:45:36 -0500 Subject: [PATCH] update docs --- README.md | 2 +- docs/index.rst | 1 + docs/using-embark-with-grunt.rst | 35 ++++++++++++++++++++++++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/using-embark-with-grunt.rst diff --git a/README.md b/README.md index f95fe1ff..8c913be4 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ With Embark you can: **Web Technologies** * Integrate with any web technology including React, Foundation, etc.. -* Use any build pipeline or tool you wish, including grunt and meteor. (for 1.x, plugins coming soon for 2.x series) +* Use any build pipeline or tool you wish, including grunt, gulp and webpack. Table of Contents ====== diff --git a/docs/index.rst b/docs/index.rst index bacae565..340daf84 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,6 +26,7 @@ This is a work in progress, feel free to contribute! deploying-to-ipfs.rst deploying-to-swarm.rst plugins.rst + using-embark-with-grunt.rst donations.rst Indices and tables diff --git a/docs/using-embark-with-grunt.rst b/docs/using-embark-with-grunt.rst new file mode 100644 index 00000000..75cf116e --- /dev/null +++ b/docs/using-embark-with-grunt.rst @@ -0,0 +1,35 @@ +Using Embark with Grunt +==================================== + +** 1. Edit embark.json ** + +Edit ``embark.json`` to have the line ``"js/app.js": ["embark.js"]``, this will make embark create the file containing the contracts initilization to ``dist/app.js``. + +.. code:: json + + { + "contracts": ["app/contracts/**"], + "app": { + "app.js": ["embark.js"] + }, + "buildDir": "dist/", + "config": "config/", + "plugins": { + } + } + +** 2. add the generated file to Grunt config file so it's included with the +other assets ** + +.. code:: coffee + + module.exports = (grunt) -> + + grunt.initConfig( + files: + js: + src: [ + "dist/app.js" + "app/js/**/*.js" + ] +