From a10bd69756a01f7ad356cc0abc6a736123ca7134 Mon Sep 17 00:00:00 2001 From: "Michael Bradley, Jr" Date: Fri, 17 May 2019 08:11:18 -0500 Subject: [PATCH] docs: move root readme into packages/embark and symlink into root --- README.md | 48 +------------------------------------- packages/embark/README.md | 49 +++++++++++++++++++++++++++++++++++---- 2 files changed, 46 insertions(+), 51 deletions(-) mode change 100644 => 120000 README.md diff --git a/README.md b/README.md deleted file mode 100644 index be6ae55f6..000000000 --- a/README.md +++ /dev/null @@ -1,47 +0,0 @@ -![Embark](https://github.com/embark-framework/embark/raw/master/header.jpg) - -[![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://dev.azure.com/embark-framework/Embark/_apis/build/status/embark-framework.embark?branchName=master)](https://dev.azure.com/embark-framework/Embark/_build/latest?definitionId=1&branchName=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) -[![Coverage Status](https://coveralls.io/repos/github/embark-framework/embark/badge.svg)](https://coveralls.io/github/embark-framework/embark) - -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/). diff --git a/README.md b/README.md new file mode 120000 index 000000000..3b48230b1 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +packages/embark/README.md \ No newline at end of file diff --git a/packages/embark/README.md b/packages/embark/README.md index adefad5d0..be6ae55f6 100644 --- a/packages/embark/README.md +++ b/packages/embark/README.md @@ -1,6 +1,47 @@ -# `embark` +![Embark](https://github.com/embark-framework/embark/raw/master/header.jpg) -> Embark is a framework that allows you to easily develop and deploy DApps +[![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://dev.azure.com/embark-framework/Embark/_apis/build/status/embark-framework.embark?branchName=master)](https://dev.azure.com/embark-framework/Embark/_build/latest?definitionId=1&branchName=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) +[![Coverage Status](https://coveralls.io/repos/github/embark-framework/embark/badge.svg)](https://coveralls.io/github/embark-framework/embark) -Visit [embark.status.im](https://embark.status.im/) to get started with -[Embark](https://github.com/embark-framework/embark). +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/).