Skip to content
This repository has been archived by the owner on Jan 24, 2022. It is now read-only.

Commit

Permalink
Update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
jbcarpanelli committed Jul 11, 2019
1 parent ed0ce6b commit 468e625
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 69 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# ZeppelinOS _(zos)_
# OpenZeppelin SDK _(openzeppelin-sdk)_

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
[![CircleCI](https://circleci.com/gh/zeppelinos/zos/tree/master.svg?style=shield)](https://circleci.com/gh/zeppelinos/zos/tree/master)
[![CircleCI](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master.svg?style=shield)](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)

> ZeppelinOS smart contract platform.
> OpenZeppelin smart contract platform.
ZeppelinOS is a platform to develop, deploy and operate smart contract
OpenZeppelin is a platform to develop, deploy and operate smart contract
projects on Ethereum and every other EVM and eWASM-powered blockchain.

This repository includes the ZeppelinOS
[Command-Line Interface](https://github.com/zeppelinos/zos/tree/master/packages/cli#readme),
[JavaScript Library](https://github.com/zeppelinos/zos/tree/master/packages/lib#readme),
and [the sources for the Documentation Website](https://github.com/zeppelinos/zos/tree/master/packages/docs#readme).
This repository includes the OpenZeppelin
[Command-Line Interface](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/cli#readme),
[JavaScript Library](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/lib#readme),
and [the sources for the Documentation Website](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/docs#readme).

## Install

First, install [Node.js](http://nodejs.org/) and [npm](https://npmjs.com/).
Then, install ZeppelinOS running:
Then, install the OpenZeppelin SDK running:

```sh
npm install --global zos
npm install --global @openzeppelin/cli
```

## Usage

We recommend to use ZeppelinOS through the `zos` command-line interface.
We recommend to use the OpenZeppelin SDK through the `openzeppelin sdk` command-line interface.

To start, create a directory for the project and access it:

Expand All @@ -40,30 +40,30 @@ Use `npm` to create a `package.json` file:
npm init
```

And initialize the ZeppelinOS project:
And initialize the OpenZeppelin SDK project:

```sh
zos init my-project
openzeppelin init my-project
```

Now it is possible to add contracts to the project with the `zos add` command,
push these contracts to a blockchain network with `zos push`, use
`zos create` to create instances for these contracts that later can be
Now it is possible to add contracts to the project with the `openzeppelin add` command,
push these contracts to a blockchain network with `openzeppelin push`, use
`openzeppelin create` to create instances for these contracts that later can be
upgraded, and many more things.

Run `zos --help` for more details about thes and all the other functions of
ZeppelinOS.
Run `openzeppelin --help` for more details about thes and all the other functions of the
OpenZeppelin CLI.

The
[ZeppelinOS documentation](https://docs.zeppelinos.org/)
[OpenZeppelin SDK documentation](https://docs.openzeppelin.com/sdk/2.4)
explains how to build a project using our platform, how to upgrade contracts,
how to share packages for other projects to reuse, how to vouch for the quality
of a package, how to use the JavaScript libraries to operate the project, and
it explains details of the platform and some advanced topics.

## Security

If you find a security issue, please contact us at security@zeppelinos.org. We
If you find a security issue, please contact us at security@openzeppelin.com. We
give rewards for reported issues, according to impact and severity.

## Maintainers
Expand All @@ -78,14 +78,14 @@ Run `npm install` in the root of the project, followed by `npx lerna bootstrap`

## Contribute

To contribute, join our [forum](https://forum.zeppelin.solutions) or
To contribute, join our [forum](https://forum.openzeppelin.com) or
[community channel on Telegram](https://t.me/zeppelinos), where you can talk to
all the ZeppelinOS developers, contributors, partners, and users.
all the OpenZeppelin developers, contributors, partners, and users.

You can also follow the recent developments of the project in our
[blog](https://blog.zeppelin.solutions/) and
[Twitter account](https://twitter.com/zeppelinorg).
[blog](https://blog.openzeppelin.com/) and
[Twitter account](https://twitter.com/openzeppelin).

## License

[MIT](LICENSE) © Zeppelin
[MIT](LICENSE) © OpenZeppelin
53 changes: 27 additions & 26 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# ZeppelinOS Command-Line Interface _(zos)_
# OpenZeppelin SDK Command-Line Interface _(@openzeppelin/cli)_

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
[![NPM Package](https://img.shields.io/npm/v/zos.svg?style=flat-square)](https://www.npmjs.org/package/zos)
[![Build Status](https://travis-ci.com/zeppelinos/zos.svg?branch=master)](https://travis-ci.com/zeppelinos/zos)
[![NPM Package](https://img.shields.io/npm/v/@openzeppelin/cli.svg?style=flat-square)](https://www.npmjs.org/package/@openzeppelin/cli)
[![CircleCI](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master.svg?style=shield)](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master)

> Command-line interface for the ZeppelinOS smart contract platform.
> Command-line interface for the OpenZeppelin SDK smart contract platform.
ZeppelinOS is a platform to develop, deploy and operate smart contract
OpenZeppelin SDK is a platform to develop, deploy and operate smart contract
projects on Ethereum and every other EVM and eWASM-powered blockchain.

This is the repository for the ZeppelinOS commmand-line interface, the
recommended way to use ZeppelinOS.
This is the repository for the OpenZeppelin commmand-line interface, the
recommended way to use the OpenZeppelin SDK.

## Install

First, install [Node.js](http://nodejs.org/) and [npm](https://npmjs.com/).
Then, install ZeppelinOS running:
Then, install the OpenZeppelin SDK running:

```sh
npm install --global zos
npm install --global @openzeppelin/cli
```

## Usage
Expand All @@ -36,47 +36,48 @@ Use `npm` to create a `package.json` file:
npm init
```

And initialize the ZeppelinOS project:
And initialize the OpenZeppelin SDK project:

```sh
zos init my-project
openzeppelin init my-project
```

Now it is possible to add contracts to the project with the `zos add` command,
push these contracts to a blockchain network with `zos push`, use
`zos create` to create instances for these contracts that later can be
Now it is possible to add contracts to the project with the `openzeppelin add` command,
push these contracts to a blockchain network with `openzeppelin push`, use
`openzeppelin create` to create instances for these contracts that later can be
upgraded, and many more things.

Run `zos --help` for more details about this and all the other functions of
ZeppelinOS.
Run `openzeppelin --help` for more details about this and all the other functions of
the OpenZeppelin CLI.

The
[ZeppelinOS documentation](https://docs.zeppelinos.org/)
explains how to use the `zos` command-line interface to build a project, to
[OpenZeppelin SDK documentation](https://docs.openzeppelin.com/sdk/2.4)
explains how to use the `openzeppelin` command-line interface to build a project, to
upgrade contracts and to share packages for other projects to reuse. It also
explains how to operate the project with the ZeppelinOS JavaScript libraries
instead of this `zos` command.
explains how to operate the project with the OpenZeppelin JavaScript libraries
instead of this `openzeppelin` command.

## Security

If you find a security issue, please contact us at security@zeppelinos.org. We
If you find a security issue, please contact us at security@openzeppelin.com. We
give rewards for reported issues, according to impact and severity.

## Maintainers

* [@facuspagnuolo](https://github.com/facuspagnuolo/)
* [@spalladino](https://github.com/spalladino)
* [@jcarpanelli](https://github.com/jcarpanelli)
* [@ylv-io](https://github.com/ylv-io)

## Contribute

To contribute, join our
[community channel on Telegram](https://t.me/zeppelinos) where you can talk to
all the ZeppelinOS developers, contributors, partners and users.
all the OpenZeppelin developers, contributors, partners and users.

You can also follow the recent developments of the project in our
[blog](https://blog.zeppelin.solutions/) and
[Twitter account](https://twitter.com/zeppelinorg).
[blog](https://blog.openzeppelin.com/) and
[Twitter account](https://twitter.com/openzeppelin).

## License

[MIT](LICENSE.md) © Zeppelin
[MIT](LICENSE.md) © OpenZeppelin
37 changes: 19 additions & 18 deletions packages/lib/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# ZeppelinOS JavaScript Library _(zos-lib)_
# OpenZeppelin SDK JavaScript Library _(@openzeppelin/upgrades)_

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
[![NPM Package](https://img.shields.io/npm/v/zos-lib.svg?style=flat-square)](https://www.npmjs.org/package/zos-lib)
[![Build Status](https://travis-ci.com/zeppelinos/zos.svg?branch=master)](https://travis-ci.com/zeppelinos/zos)
[![NPM Package](https://img.shields.io/npm/v/@openzeppelin/upgrades.svg?style=flat-square)](https://www.npmjs.org/package/@openzeppelin/upgrades)
[![CircleCI](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master.svg?style=shield)](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master)
[![Coverage Status](https://coveralls.io/repos/github/zeppelinos/zos-lib/badge.svg?branch=master)](https://coveralls.io/github/zeppelinos/zos-lib?branch=master)

> JavaScript library for the ZeppelinOS smart contract platform.
> JavaScript library for the OpenZeppelin SDK smart contract platform.
ZeppelinOS is a platform to develop, deploy and operate smart contract
OpenZeppelin SDK is a platform to develop, deploy and operate smart contract
projects on Ethereum and every other EVM and eWASM-powered blockchain.

This is the repository for the ZeppelinOS JavaScript library. It is mainly used
This is the repository for the OpenZeppelin SDK JavaScript library. It is mainly used
by the
[`zos` command-line interface](https://github.com/zeppelinos/zos/tree/master/packages/cli#zeppelinos-command-line-interface),
which is the recommended way to use ZeppelinOS; but this library can also be
used directly to operate ZeppelinOS projects when a programmatic interface is
[`openzeppelin-sdk` command-line interface](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/cli#openzeppelin-sdk-command-line-interface-openzeppelincli),
which is the recommended way to use the OpenZeppelin SDK; but this library can also be
used directly to operate projects when a programmatic interface is
preferred or more flexibility and lower-level access is required.

## Install

First, install [Node.js](http://nodejs.org/) and [npm](https://npmjs.com/).
Then, install the ZeppelinOS JavaScript Library running:
Then, install the OpenZeppelin SDK JavaScript Library running:

```sh
npm install zos-lib
npm install @openzeppelin/upgrades
```

## Usage
Expand All @@ -40,7 +40,7 @@ node
```

```js
> const { ZWeb3, Contracts, SimpleProject } = require('zos-lib')
> const { ZWeb3, Contracts, SimpleProject } = require('@openzeppelin/upgrades')
> // Initialize a web3 provider.
> ZWeb3.initialize("http://localhost:9545")
> // Load the contract.
Expand All @@ -56,7 +56,7 @@ node

## Security

If you find a security issue, please contact us at security@zeppelinos.org. We
If you find a security issue, please contact us at security@openzeppelin.com. We
give rewards for reported issues, according to impact and severity.

## API
Expand All @@ -65,19 +65,20 @@ TODO.

## Maintainers

* [@facuspagnuolo](https://github.com/facuspagnuolo/)
* [@spalladino](https://github.com/spalladino)
* [@jcarpanelli](https://github.com/jcarpanelli)
* [@ylv-io](https://github.com/ylv-io)

## Contribute

To contribute, join our
[community channel on Telegram](https://t.me/zeppelinos) where you can talk to
all the ZeppelinOS developers, contributors, partners and users.
all the OpenZeppelin developers, contributors, partners and users.

You can also follow the recent developments of the project in our
[blog](https://blog.zeppelin.solutions/) and
[Twitter account](https://twitter.com/zeppelinorg).
[blog](https://blog.openzeppelin.com/) and
[Twitter account](https://twitter.com/openzeppelin).

## License

[MIT](LICENSE.md) © Zeppelin
[MIT](LICENSE.md) © OpenZeppelin

0 comments on commit 468e625

Please sign in to comment.