Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NikhilVerma committed Jun 15, 2022
1 parent 20a8909 commit 65bd244
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
@@ -1,8 +1,8 @@
# protobufjs-typescript-gen
# @cldcvr/protobufjs-typescript-gen

<a href="https://npmjs.org/package/protobufjs-typescript-gen"><img src="https://img.shields.io/npm/v/protobufjs-typescript-gen.svg" alt=""></a> <a href="https://npmjs.org/package/protobufjs-typescript-gen"><img src="https://img.shields.io/npm/dm/protobufjs-typescript-gen.svg" alt=""></a>
<a href="https://npmjs.org/package/@cldcvr/protobufjs-typescript-gen"><img src="https://img.shields.io/npm/v/@cldcvr/protobufjs-typescript-gen.svg" alt=""></a> <a href="https://npmjs.org/package/@cldcvr/protobufjs-typescript-gen"><img src="https://img.shields.io/npm/dm/@cldcvr/protobufjs-typescript-gen.svg" alt=""></a>

**protobufjs-typescript-gen** is a tool which used protocol buffers to generate a Typescript interface. The tool is currently highly opinionated in how it generates files. It internally uses protobuf.js.
**@cldcvr/protobufjs-typescript-gen** is a tool which used protocol buffers to generate a Typescript interface. The tool is currently highly opinionated in how it generates files. It internally uses protobuf.js.

**protobuf.js** is a pure JavaScript implementation with [TypeScript](https://www.typescriptlang.org) support for [node.js](https://nodejs.org) and the browser. It's easy to use, blazingly fast and works out of the box with [.proto](https://developers.google.com/protocol-buffers/docs/proto) files!

Expand All @@ -11,15 +11,15 @@
### node.js

```bash
$> npm install protobufjs-typescript-gen [--save --save-prefix=~]
$> npm install @cldcvr/protobufjs-typescript-gen [--save --save-prefix=~]
```

```js
// generate-protocol.js
const { generateProtocol } = require('protobufjs-typescript-gen');
const { generateProtocol } = require('@cldcvr/protobufjs-typescript-gen');

generateProtocol({
cwd: 'YOUR_PROTOCOL_DIRECTORY',
protocolDir: 'YOUR_PROTOCOL_DIRECTORY',
outDir: 'YOUR_OUTPUT_DIRECTORY',
});
```
Expand Down

0 comments on commit 65bd244

Please sign in to comment.