Skip to content

Commit

Permalink
chore: add logo to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chakhsu committed Jan 9, 2024
1 parent 6bc408d commit 883d16a
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 6 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# gRPCity ![build-status](https://github.com/chakhsu/grpcity/actions/workflows/build.yml/badge.svg) ![npm](https://img.shields.io/npm/v/grpcity) ![license](https://img.shields.io/npm/l/grpcity)

<img src="./docs/grpcity-logo.svg" width="160" height="160" alt="grpcity logo" align="right">

[English](./README.md) | [简体中文](./README_CN.md)

## Introduction
Expand Down Expand Up @@ -69,10 +71,10 @@ message Message {
Next, create `loader.js` and write the following code in it:

```js
import GrpcLoader from 'grpcity'
import { ProtoLoader } from 'grpcity'
import path from 'node:path'

export default new GrpcLoader({
export default new ProtoLoader({
location: path.join(__dirname, './'),
files: ['greeter.proto']
})
Expand Down Expand Up @@ -131,7 +133,7 @@ const start = async (addr) => {
start('127.0.0.1:9099')
```

Once the programming work is completed, you can start it by running:
Once the programming work is completed, you can start it in the terminal by running:

```sh
node ./server.js
Expand Down
8 changes: 5 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# gRPCity ![build-status](https://github.com/chakhsu/grpcity/actions/workflows/build.yml/badge.svg) ![npm](https://img.shields.io/npm/v/grpcity) ![license](https://img.shields.io/npm/l/grpcity)

<img src="./docs/grpcity-logo.svg" width="160" height="160" alt="grpcity logo" align="right">

[English](./README.md) | [简体中文](./README_CN.md)

## 介绍
Expand Down Expand Up @@ -64,10 +66,10 @@ message Message {
然后,创建`loader.js`, 编写下面的代码到其中:

```js
import GrpcLoader from 'grpcity'
import { ProtoLoader } from 'grpcity'
import path from 'node:path'

export default new GrpcLoader({
export default new ProtoLoader({
location: path.join(__dirname, './'),
files: ['greeter.proto']
})
Expand Down Expand Up @@ -126,7 +128,7 @@ const start = async (addr) => {
start('127.0.0.1:9099')
```

完成编程工作之后,就可以通过下面的命令启动~
完成编程工作之后,就可以在终端里执行下面命令进行启动~

```sh
node ./server.js
Expand Down
59 changes: 59 additions & 0 deletions docs/grpcity-logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/grpcity-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 883d16a

Please sign in to comment.