Skip to content

Commit 65bd244

Browse files
committed
Update readme
1 parent 20a8909 commit 65bd244

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# protobufjs-typescript-gen
1+
# @cldcvr/protobufjs-typescript-gen
22

3-
<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>
3+
<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>
44

5-
**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.
5+
**@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.
66

77
**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!
88

@@ -11,15 +11,15 @@
1111
### node.js
1212

1313
```bash
14-
$> npm install protobufjs-typescript-gen [--save --save-prefix=~]
14+
$> npm install @cldcvr/protobufjs-typescript-gen [--save --save-prefix=~]
1515
```
1616

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

2121
generateProtocol({
22-
cwd: 'YOUR_PROTOCOL_DIRECTORY',
22+
protocolDir: 'YOUR_PROTOCOL_DIRECTORY',
2323
outDir: 'YOUR_OUTPUT_DIRECTORY',
2424
});
2525
```

0 commit comments

Comments
 (0)