Skip to content

Commit d689a02

Browse files
committed
updated readme
1 parent abe43a8 commit d689a02

File tree

4 files changed

+35
-16
lines changed

4 files changed

+35
-16
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@ Swell is a one-stop shop for sending and monitoring your API requests:
4545
<!-- -TODO --- This needs to be updated -->
4646
<img src="./ReadMeGifs/Gifs/gRPC.gif" style="display: block; margin: 10px auto 30px;" />
4747

48+
- _tRPC_: Swell includes full support for all methods of TypeScript Remote Procedure Calls including batch call support for queries and mutations.
49+
<img src="./ReadMeGifs/Gifs/trpc.gif" style="display: block; margin: 10px auto 30px;" />
50+
<!-- <img src="./ReadMeGifs/Gifs/tRPC-subscription.gif" style="display: block; margin: 10px auto 30px;" /> -->
51+
52+
Calls are currently being made using Swell's own TRPCProxyClient generated from the URL provided by the user.
53+
Batch requests must be entered one request per line. Swell will treat each line of code entered into the editor as a separate request before batching and returning responses.
54+
Each request must follow the general format client.procedure.querytype(). For example:
55+
56+
```js
57+
client.getUser.query({ name: 'Luke Skywalker' });
58+
```
59+
60+
See [tRPC docs](https://trpc.io/docs/) for more information on sending tRPC requests or setting up a tRPC server.
61+
4862
## Additional features
4963

5064
- _Stress testing for HTTP/2 and GraphQL_: Test your server backend with Swell's stress testing feature to ensure your server can manage expected and unexpected loads accordingly
@@ -70,20 +84,6 @@ Swell is a one-stop shop for sending and monitoring your API requests:
7084
- _Mock Server_: Swell allows you to create your own HTTP/2 mock server to facilitate front-end development without depending on a fully built backend server.
7185
<img src="./ReadMeGifs/Gifs/MockServer.gif" style="display: block; margin: 10px auto 30px;" />
7286

73-
- _tRPC_: Swell includes full support for all methods of TypeScript Remote Procedure Calls including batch call support for queries and mutations.
74-
<img src="./ReadMeGifs/Videos/Short%20Feature%20Videos/720-MP4s/TRPC.mp4" style="display: block; margin: 10px auto 30px;" />
75-
<!-- <img src="./ReadMeGifs/Gifs/tRPC-subscription.gif" style="display: block; margin: 10px auto 30px;" /> -->
76-
77-
Calls are currently being made using Swell's own TRPCProxyClient generated from the URL provided by the user.
78-
Batch requests must be entered one request per line. Swell will treat each line of code entered into the editor as a separate request before batching and returning responses.
79-
Each request must follow the general format client.procedure.querytype(). For example:
80-
81-
```js
82-
client.getUser.query({ name: 'Luke Skywalker' });
83-
```
84-
85-
See [tRPC docs](https://trpc.io/docs/) for more information on sending tRPC requests or setting up a tRPC server.
86-
8787
- _Webhooks_: Swell includes user-defined HTTP callback connection testing designed to test other server's connection to the web and ability to send data. The test insures that when an event occurs, the source site makes an HTTP request to the URL configured for the webhook.
8888
<img src="./ReadMeGifs/Gifs/Webhook.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" />
8989

ReadMeGifs/Gifs/tRPC.gif

-1.21 MB
Binary file not shown.

ReadMeGifs/Gifs/trpc.gif

936 KB
Loading

package.json

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "swell",
3-
"version": "1.14.0",
3+
"version": "1.15.0",
44
"description": "Swell",
55
"main": "main.js",
66
"repository": "https://github.com/open-source-labs/Swell",
@@ -96,10 +96,13 @@
9696
"dependencies": {
9797
"@apollo/client": "^3.5.0",
9898
"@apollo/server": "^4.6.0",
99+
"@emotion/react": "^11.11.1",
100+
"@emotion/styled": "^11.11.0",
99101
"@graphql-tools/schema": "^8.3.10",
100102
"@grpc/grpc-js": "^1.6.7",
101103
"@grpc/proto-loader": "^0.6.9",
102104
"@jest-runner/electron": "^3.0.1",
105+
"@mui/styled-engine": "^5.13.2",
103106
"@redux-devtools/extension": "^3.2.2",
104107
"@reduxjs/toolkit": "^1.8.1",
105108
"@testing-library/react": "^14.0.0",
@@ -195,7 +198,7 @@
195198
"cross-env": "^7.0.3",
196199
"csp-html-webpack-plugin": "^5.1.0",
197200
"css-loader": "^6.7.1",
198-
"electron": "^18.3.5",
201+
"electron": "^18.3.15",
199202
"electron-builder": "^24.1.3",
200203
"electron-ipc-mock": "^0.0.3",
201204
"electron-react-devtools": "^0.5.3",
@@ -500,6 +503,22 @@
500503
{
501504
"name": "Kurtis Waterbury",
502505
"url": "https://github.com/kurto8"
506+
},
507+
{
508+
"name": "Nguyen Nguyen",
509+
"url": "https://github.com/nqnguyen1"
510+
},
511+
{
512+
"name": "Derek Nyren",
513+
"url": "https://github.com/Dereknyren"
514+
},
515+
{
516+
"name": "Jeremy Chen",
517+
"url": "https://github.com/JeremyC3"
518+
},
519+
{
520+
"name": "Elisa Aigamaua",
521+
"url": "https://github.com/eaaigama"
503522
}
504523
]
505524
}

0 commit comments

Comments
 (0)