xrpl 1.10.0 → 2.0.0-beta.3

package/LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2012-2021 Contributers to xrpl.js
+Copyright (c) 2012-2015 Ripple Labs Inc.
 
 Permission to use, copy, modify, and distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -1,8 +1,8 @@
-# ripple-lib (RippleAPI)
+# xrpl.js
 
-A JavaScript/TypeScript API for interacting with the XRP Ledger
+A JavaScript/TypeScript library for interacting with the XRP Ledger
 
-[![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib)
+[![NPM](https://nodei.co/npm/xrpl.png)](https://www.npmjs.org/package/xrpl)
 
 This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.
 
@@ -12,7 +12,7 @@ See the full reference documentation on the XRP Ledger Dev Portal.
 
 ## [➡️ Applications and Projects](APPLICATIONS.md)
 
-What is ripple-lib used for? The applications on the list linked above use `ripple-lib`. Open a PR to add your app or project to the list!
+What is xrpl.js used for? The applications on the list linked above use `xrpl.js`. Open a PR to add your app or project to the list!
 
 ### Features
 
@@ -25,32 +25,32 @@ What is ripple-lib used for? The applications on the list linked above use `ripp
 ### Requirements
 
 + **[Node.js v14](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
-+ **[Yarn](https://yarnpkg.com/)** is recommended. `npm` may work but we use `yarn.lock`.
++ **[npm](https://www.npmjs.com/)** is recommended. `yarn` may work but we use `package-lock.json`.
 
 ## Getting Started
 
 See also: [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
 
-In an existing project (with `package.json`), install `ripple-lib`:
+In an existing project (with `package.json`), install `xrpl.js`:
 ```
-$ yarn add ripple-lib
+$ npm install xrpl
 ```
 
 Then see the [documentation](#documentation).
 
-### Using ripple-lib with React Native
+### Using xrpl.js with React Native
 
-If you want to use `ripple-lib` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
+If you want to use `xrpl.js` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
 
 1. Install dependencies (you can use `npm` as well):
 
     ```shell
-    yarn add react-native-crypto
-    yarn add ripple-lib 
+    npm install react-native-crypto
+    npm install xrpl
     # install peer deps
-    yarn add react-native-randombytes
+    npm install react-native-randombytes
     # install latest rn-nodeify
-    yarn add rn-nodeify@latest --dev
+    npm install rn-nodeify@latest --dev
     ```
 
 2. After that, run the following command:
@@ -79,15 +79,15 @@ If you want to use `ripple-lib` with React Native you will need to have some of
   ...
   ```
 
-### Using ripple-lib with Deno
+### Using xrpl.js with Deno
 
-Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `ripple-lib` with Deno:
+Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `xrpl.js` with Deno:
 
 ```javascript
-import ripple from 'https://dev.jspm.io/npm:ripple-lib';
+import xrpl from 'https://dev.jspm.io/npm:xrpl';
 
 (async () => {
-  const api = new (ripple as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
+  const api = new (xrpl as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
   const address = 'rH8NxV12EuV...khfJ5uw9kT';
 
   api.connect().then(() => {
@@ -106,7 +106,7 @@ import ripple from 'https://dev.jspm.io/npm:ripple-lib';
 
 ### Mailing Lists
 
-We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)
+We have a low-traffic mailing list for announcements of new xrpl.js releases. (About 1 email per week)
 
 + [Subscribe to ripple-lib-announce](https://groups.google.com/forum/#!forum/ripple-lib-announce)
 
@@ -118,7 +118,7 @@ If you're using the XRP Ledger in production, you should run a [rippled server](
 
 To build the library for Node.js and the browser:
 ```
-$ yarn build
+$ npm run build
 ```
 
 The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
@@ -132,25 +132,19 @@ For details, see the `scripts` in `package.json`.
 ### Unit Tests
 
 1. Clone the repository
-2. `cd` into the repository and install dependencies with `yarn install`
-3. `yarn test`
+2. `cd` into the repository and install dependencies with `npm install`
+3. `npm test`
 
 ### Linting
 
-Run `yarn lint` to lint the code with `eslint`.
+Run `npm run lint` to lint the code with `eslint`.
 
 ## Generating Documentation
 
-Do not edit `./docs/index.md` directly because it is a generated file.
-
-Instead, edit the appropriate `.md.ejs` files in `./docs/src/`.
-
-If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running `yarn run docgen`.
+Update the documentation by running `npm run docgen`.
 
 ## More Information
 
 + [ripple-lib-announce mailing list](https://groups.google.com/forum/#!forum/ripple-lib-announce) - subscribe for release announcements
 + [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal
 + [XRP Ledger Dev Portal](https://xrpl.org/)
-
- [![Build Status](https://travis-ci.org/ripple/ripple-lib.svg?branch=master)](https://travis-ci.org/ripple/ripple-lib)