@digitalasset/daml-ledger/README.DOCS.md

DAML Ledger API Node.js bindings

# Node.js bindings for DAML

The [Node.js](https://node.js.org/) bindings for [DAML](https://daml.com/) allow you to write applications on the Node.js platform that interact with a DAML application through the [Ledger API](https://docs.daml.com/app-dev/ledger-api-introduction/index.html).

## Status

**The Node.js bindings are deprecated as of 2020-10-14.**

Either switch to the [JavaScript client
libraries](https://docs.daml.com/app-dev/bindings-ts/index.html)
running over the HTTP JSON API or to the [Java
bindings](https://docs.daml.com/app-dev/bindings-java/index.html)
which are based on the gRPC ledger API.

## Table of contents

- [Read the documentation](#read-the-documentation)
- [Get started](#get-started)

## Read the documentation

This page offers some guidance on how to move the first steps to write your applications running on Node.js and interacting with a DAML.

Keep on reading for a few pointers on how to get started.

Navigate through the reference docs using the navigation items on the side of this page.

[Go back to the top](#table-of-contents)

## Get started

You can add the bindings to an existing Node.js project running

    npm install @digitalasset/daml-ledger

If you need some guidance on how to move your first steps with the bindings you can try the [tutorial](https://github.com/digital-asset/ex-tutorial-nodejs).

[Go back to the top](#table-of-contents)