diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..34a9d05 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright (c) Consensys LLC, and authors. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 30f8730..ae6a3ca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Truffle Migrate: Off-chain -This library acts as a drop-in replacement for Truffle's `migrate` command. It stores the migration version and deployed contract addresses for each network in the local filesystem. This means that development networks can added to .gitignore, and production deployments can be committed: allowing easier integration with continuous deployment processes. +This library acts as a drop-in replacement for Truffle's `migrate` command. It stores the migration version and deployed contract addresses for each network off-chain in the local filesystem. This means that development networks can added to .gitignore, and production deployments can be committed: allowing easier integration with continuous deployment processes. # Setup @@ -80,3 +80,7 @@ The key here is that the Truffle build artifact network addresses are derived fr - Different networks may have different versions of a contract's bytecode deployed. However, they will all still be added to the same Truffle artifact. This means that the address is not strictly tied to an ABI. It's unlikely to be a problem but it's something to keep in mind. This is really an existing issue, however. - Deploying a contract to the same network twice is not currently supported. Networks are distinguished by their network_id rather than an alias, so you have to scope the 'latest' set of contracts by network. + +# License + +Note that this project borrows code heavily from `truffle-migrate` and `truffle-core`. This code is similarly licensed under the MIT license.