Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zzzen committed Oct 28, 2020
1 parent cd27d04 commit 99a982f
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# pb-parser

a simple protobuf parser written in typescript.

## Installation

```sh
npm install pb-parser
```

## Usage

```js
import { parse } from "pb-parser";

const file = parse(`syntax = "proto3";`);
console.log(file);
```

## Testing

To run the tests, run the following command:

```sh
npm test
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"keywords": [],
"author": "",
"license": "ISC",
"license": "MIT",
"devDependencies": {
"@babel/core": "^7.11.1",
"@babel/plugin-proposal-class-properties": "^7.10.4",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Parser } from "./parser";

export function parse(src: string, _options: unknown) {
export function parse(src: string) {
return new Parser(src).parse();
}

Expand Down

0 comments on commit 99a982f

Please sign in to comment.