From 99a982fc93364be0291cccaa31299c85395ec5bc Mon Sep 17 00:00:00 2001 From: Zzzen Date: Wed, 28 Oct 2020 22:30:14 +0800 Subject: [PATCH] add README.md --- README.md | 26 ++++++++++++++++++++++++++ package.json | 2 +- src/index.ts | 2 +- 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ac6477 --- /dev/null +++ b/README.md @@ -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 +``` diff --git a/package.json b/package.json index 51dcd08..bc40b54 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ }, "keywords": [], "author": "", - "license": "ISC", + "license": "MIT", "devDependencies": { "@babel/core": "^7.11.1", "@babel/plugin-proposal-class-properties": "^7.10.4", diff --git a/src/index.ts b/src/index.ts index f44446b..7ae79c3 100644 --- a/src/index.ts +++ b/src/index.ts @@ -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(); }