Update README.md
This commit is contained in:
parent
930752411a
commit
ed5b49f2b4
49
README.md
49
README.md
|
@ -62,8 +62,6 @@ This will automatically deploy the contracts, update their JS bindings and deplo
|
||||||
|
|
||||||
Note that if you update your code it will automatically be re-deployed, contracts included. There is no need to restart embark, refreshing the page on the browser will do.
|
Note that if you update your code it will automatically be re-deployed, contracts included. There is no need to restart embark, refreshing the page on the browser will do.
|
||||||
|
|
||||||
note: for a demo using meteor do ```embark meteor_demo``` followed by ```embark deploy``` then ```meteor```
|
|
||||||
|
|
||||||
Creating a new DApp
|
Creating a new DApp
|
||||||
======
|
======
|
||||||
|
|
||||||
|
@ -82,11 +80,10 @@ DApp Structure
|
||||||
|___ css/
|
|___ css/
|
||||||
|___ js/
|
|___ js/
|
||||||
config/
|
config/
|
||||||
|___ blockchain.yml #environments configuration
|
|___ blockchain.json #environments configuration
|
||||||
|___ contracts.yml #contracts configuration
|
|___ contracts.json #contracts configuration
|
||||||
|___ server.yml #server configuration
|
test/
|
||||||
spec/
|
|___ #contracts tests
|
||||||
|___ contracts/ #contracts tests
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Solidity/Serpent files in the contracts directory will automatically be deployed with embark run. Changes in any files will automatically be reflected in app, changes to contracts will result in a redeployment and update of their JS Bindings
|
Solidity/Serpent files in the contracts directory will automatically be deployed with embark run. Changes in any files will automatically be reflected in app, changes to contracts will result in a redeployment and update of their JS Bindings
|
||||||
|
@ -123,15 +120,20 @@ SimpleStorage.storedData();
|
||||||
|
|
||||||
You can specify for each contract and environment its gas costs and arguments:
|
You can specify for each contract and environment its gas costs and arguments:
|
||||||
|
|
||||||
```Yaml
|
```Json
|
||||||
# config/contracts.yml
|
# config/contracts.json
|
||||||
development:
|
{
|
||||||
SimpleStorage:
|
"development": {
|
||||||
gas_limit: 500000
|
"gas": "auto",
|
||||||
gas_price: 10000000000000
|
"contracts": {
|
||||||
args:
|
"SimpleStorage": {
|
||||||
- 100
|
"args": [
|
||||||
...
|
100
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If you are using multiple contracts, you can pass a reference to another contract as ```$ContractName```, Embark will automatically replace this with the correct address for the contract.
|
If you are using multiple contracts, you can pass a reference to another contract as ```$ContractName```, Embark will automatically replace this with the correct address for the contract.
|
||||||
|
@ -210,19 +212,26 @@ You can also define contract interfaces (Stubs) and actions to do on deployment
|
||||||
Tests
|
Tests
|
||||||
======
|
======
|
||||||
|
|
||||||
You can run specs with ```embark spec```, it will run any test files under ```test/```.
|
You can run specs with ```embark test```, it will run any test files under ```test/```.
|
||||||
|
|
||||||
Embark includes a testing lib to fastly run & test your contracts in a EVM.
|
Embark includes a testing lib to fastly run & test your contracts in a EVM.
|
||||||
|
|
||||||
```Javascript
|
```Javascript
|
||||||
# test/simple_storage_spec.js
|
# test/simple_storage_spec.js
|
||||||
|
|
||||||
var assert = require('assert');
|
var assert = require('assert');
|
||||||
var Embark = require('embark-framework');
|
var Embark = require('embark-framework');
|
||||||
var EmbarkSpec = Embark.initTests();
|
var EmbarkSpec = Embark.initTests();
|
||||||
|
var web3 = EmbarkSpec.web3;
|
||||||
|
|
||||||
describe("SimpleStorage", function(done) {
|
describe("SimpleStorage", function() {
|
||||||
before(function(done) {
|
before(function(done) {
|
||||||
EmbarkSpec.deployAll(done);
|
var contractsConfig = {
|
||||||
|
"SimpleStorage": {
|
||||||
|
args: [100]
|
||||||
|
}
|
||||||
|
};
|
||||||
|
EmbarkSpec.deployAll(contractsConfig, done);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should set constructor value", function(done) {
|
it("should set constructor value", function(done) {
|
||||||
|
@ -241,7 +250,7 @@ describe("SimpleStorage", function(done) {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
})
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
Embark uses [Mocha](http://mochajs.org/) by default, but you can use any testing framework you want.
|
Embark uses [Mocha](http://mochajs.org/) by default, but you can use any testing framework you want.
|
||||||
|
|
Loading…
Reference in New Issue