embark/README.md

![Embark](https://github.com/embark-framework/embark/raw/master/header.png)

[![npm](https://img.shields.io/npm/dm/embark.svg)](https://npmjs.com/package/embark)
[![Gitter](https://img.shields.io/gitter/room/embark-framework/Lobby.svg)](https://gitter.im/embark-framework/Lobby)
[![Build Status](https://travis-ci.org/embark-framework/embark.svg?branch=master)](https://travis-ci.org/embark-framework/embark)
[![Build status](https://ci.appveyor.com/api/projects/status/nnq38x2hi3q11o44/branch/master?svg=true)](https://ci.appveyor.com/project/iurimatias/embark/branch/master)
![Open PRs](https://img.shields.io/github/issues-pr-raw/embark-framework/embark.svg)
![Closed PRs](https://img.shields.io/github/issues-pr-closed-raw/embark-framework/embark.svg)
![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/y/embark-framework/embark.svg)

What is Embark
======

Embark is a framework that allows you to easily develop and deploy Decentralized Applications (DApps).

A Decentralized Application is a serverless html5 application that uses one or more decentralized technologies.

Embark currently integrates with EVM blockchains (Ethereum), Decentralized Storages (IPFS), and Decentralized communication platforms (Whisper and Orbit). Swarm is supported for deployment.

With Embark you can:

**Blockchain (Ethereum)**
* Automatically deploy contracts and make them available in your JS code. Embark watches for changes, and if you update a contract, Embark will automatically redeploy the contracts (if needed) and the dapp.
* Contracts are available in JS with Promises.
* Do Test Driven Development with Contracts using Javascript.
* Keep track of deployed contracts; deploy only when truly needed.
* Manage different chains (e.g testnet, private net, livenet)
* Easily manage complex systems of interdependent contracts.

**Decentralized Storage (IPFS, Swarm)**
* Easily Store & Retrieve Data on the DApp through EmbarkJS. Including uploading and retrieving files.
* Deploy the full application to IPFS or Swarm.
* Import and deploy contracts hosted on Swarm.


**Decentralized Communication (Whisper, Orbit)**
* Easily send/receive messages through channels in P2P through Whisper or Orbit.

**Web Technologies**
* Integrate with any web technology including React, Foundation, etc..
* Use any build pipeline or tool you wish, including grunt, gulp and webpack.

```Bash
$ npm -g install embark
```

See [Complete Documentation](https://embark.status.im/docs/).
update badges to use master instead of develop 2018-11-09 04:18:55 -05:00			`![Embark](https://github.com/embark-framework/embark/raw/master/header.png)`
add logo 2017-10-10 07:01:27 -04:00
Update README.md 2017-10-02 14:07:47 -04:00			`[![npm](https://img.shields.io/npm/dm/embark.svg)](https://npmjs.com/package/embark)`
update link to gitter room 2018-02-19 16:22:54 -05:00			`[![Gitter](https://img.shields.io/gitter/room/embark-framework/Lobby.svg)](https://gitter.im/embark-framework/Lobby)`
update badges to use master instead of develop 2018-11-09 04:18:55 -05:00			`[![Build Status](https://travis-ci.org/embark-framework/embark.svg?branch=master)](https://travis-ci.org/embark-framework/embark)`
			`[![Build status](https://ci.appveyor.com/api/projects/status/nnq38x2hi3q11o44/branch/master?svg=true)](https://ci.appveyor.com/project/iurimatias/embark/branch/master)`
fix badges 2018-09-27 18:19:14 -04:00			`![Open PRs](https://img.shields.io/github/issues-pr-raw/embark-framework/embark.svg)`
			`![Closed PRs](https://img.shields.io/github/issues-pr-closed-raw/embark-framework/embark.svg)`
fix commits badge 2018-09-27 18:15:25 -04:00			`![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/y/embark-framework/embark.svg)`
update readme 2015-06-21 22:14:22 -04:00
adjust sticker position 2016-10-22 18:36:57 -04:00			`What is Embark`
			`======`

Update README.md 2017-02-06 20:37:40 -05:00			`Embark is a framework that allows you to easily develop and deploy Decentralized Applications (DApps).`

documentation update: typo fixes etc 2017-03-22 16:46:12 -05:00			`A Decentralized Application is a serverless html5 application that uses one or more decentralized technologies.`
Update README.md 2017-02-06 20:37:40 -05:00
documentation update: typo fixes etc 2017-03-22 16:46:12 -05:00			`Embark currently integrates with EVM blockchains (Ethereum), Decentralized Storages (IPFS), and Decentralized communication platforms (Whisper and Orbit). Swarm is supported for deployment.`
update readme 2015-06-21 22:14:22 -04:00
			`With Embark you can:`
Update README.md 2017-02-06 20:37:40 -05:00
			`Blockchain (Ethereum)`
update readme 2015-06-21 22:14:22 -04:00			`* Automatically deploy contracts and make them available in your JS code. Embark watches for changes, and if you update a contract, Embark will automatically redeploy the contracts (if needed) and the dapp.`
update docs 2017-03-04 19:01:05 -05:00			`* Contracts are available in JS with Promises.`
update readme 2015-06-21 22:14:22 -04:00			`* Do Test Driven Development with Contracts using Javascript.`
documentation update: typo fixes etc 2017-03-22 16:46:12 -05:00			`* Keep track of deployed contracts; deploy only when truly needed.`
update readme 2015-10-12 18:33:00 -04:00			`* Manage different chains (e.g testnet, private net, livenet)`
Update README.md 2017-02-06 20:39:51 -05:00			`* Easily manage complex systems of interdependent contracts.`
Update README.md 2017-02-06 20:37:40 -05:00
feat: adds support for swarm imports in Solidity This commit enables users of Embark to import any Solidity contract using the swarm protocol. Example: ``` import "bzz:/someensdomain.eth/ERC725.sol"; ``` Closes #766 2018-11-06 15:29:47 +05:30			`Decentralized Storage (IPFS, Swarm)`
documentation update: typo fixes etc 2017-03-22 16:46:12 -05:00			`* Easily Store & Retrieve Data on the DApp through EmbarkJS. Including uploading and retrieving files.`
Update README.md 2017-02-06 20:37:40 -05:00			`* Deploy the full application to IPFS or Swarm.`
feat: adds support for swarm imports in Solidity This commit enables users of Embark to import any Solidity contract using the swarm protocol. Example: ``` import "bzz:/someensdomain.eth/ERC725.sol"; ``` Closes #766 2018-11-06 15:29:47 +05:30			`* Import and deploy contracts hosted on Swarm.`
Update README.md 2017-02-06 20:37:40 -05:00

			`Decentralized Communication (Whisper, Orbit)`
			`* Easily send/receive messages through channels in P2P through Whisper or Orbit.`

			`Web Technologies`
			`* Integrate with any web technology including React, Foundation, etc..`
update docs 2017-03-04 15:45:36 -05:00			`* Use any build pipeline or tool you wish, including grunt, gulp and webpack.`
update readme 2015-06-22 06:07:46 -04:00
Create README.md 2015-05-25 08:21:53 -04:00			```Bash
Update README.md 2016-10-16 15:14:48 -04:00			`$ npm -g install embark`
Create README.md 2015-05-25 08:21:53 -04:00			```

update README 2018-05-03 20:29:11 -04:00			`See [Complete Documentation](https://embark.status.im/docs/).`