Skip to content

Commit a068797

Browse files
authored
Merge pull request #236 from open-source-labs/readMeStuff
Updated README
2 parents 3afb2bb + 8f3a070 commit a068797

10 files changed

+39
-18
lines changed

README.md

Lines changed: 39 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,70 @@
1-
<img src="./src/assets/img/horizontal-logo-lockup.png" style="margin-top: 10px; margin-bottom: -10px">
1+
<p align="center"><img src="./src/assets/img/horizontal-logo-lockup.png" style="margin-top: 10px; margin-bottom: -10px;"></p>
22

33
#
4-
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Swell-%20For%20all%20your%20streaming%20API%20testing%20needs&url=https://www.getswell.io&hashtags=SSE,WebSocket,HTTP,API,developers)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/open-source-labs/Swell/blob/master/LICENSE.txt)
55
![AppVeyor](https://img.shields.io/badge/build-passing-brightgreen.svg)
6-
![AppVeyor](https://img.shields.io/badge/version-0.1.0-blue.svg)
6+
![AppVeyor](https://img.shields.io/badge/version-0.2.0-blue.svg)
77
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/getswell/getswell/issues)
8+
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Swell-%20For%20all%20your%20streaming%20API%20testing%20needs&url=https://www.getswell.io&hashtags=SSE,WebSocket,HTTP,API,developers)
89

910

1011

11-
Swell is a Streaming API development tool that enables developers to test API endpoints served over modern networking technologies including Server-Sent Events (SSE), WebSocket, and HTTP2.
12+
Swell is a API development tool that enables developers to test endpoints served over streaming technologies including Server-Sent Events (SSE), WebSockets, HTTP2, and GraphQL.
1213

1314
## Getting Started
1415

1516
Visit www.getswell.io to download the latest release.
1617

1718
Swell is currently available for OS X, Linux and Windows.
1819

19-
### Features
20+
## Highlights
2021
Swell is a one-stop shop for sending and monitoring your API requests
2122

22-
<kbd><img src="https://i.imgur.com/tcfbCPf.jpg"
23-
style="float: left; margin-right: 10px;margin-bottom : 40px; margin-top : 10px;" /></kbd>
24-
25-
* Send and monitor up to six concurrent connections
26-
* Interactive chart delivers request/response timing information in an easy to digest form
23+
* Send and monitor requests over HTTP2 (including SSEs), WebSockets, and GraphQL
24+
* Support for up to six concurrent connections
25+
* View request/response timing information in an interactive chart
26+
* Save requests in "collections" of multiple requests
27+
* Minimize and maximize requests
2728
* Native OS/X app
2829

29-
### Supported Technologies
30+
## Supported Technologies
3031
* *HTTP2*: Swell supports full HTTP2 multiplexing of requests and responses. HTTP requests to the same host will be sent over the same connection. Swell will attempt to initiate an HTTP2 connection for all HTTPS requests by default, but will revert to HTTP1.1 for legacy servers.
31-
<kbd><img src="https://i.imgur.com/jxY2Y2y.png"
32+
<kbd><img src="./ReadMeGifs/Swell_API_6_Concurrent_Eevee_Requests.gif"
3233
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
3334

3435
* *Server-Sent Events (SSE)*: Swell displays SSE events one by one as they come in.
35-
<kbd><img src="https://i.imgur.com/SrzGDxM.png"
36+
<kbd><img src="./ReadMeGifs/Swell_API_3_SSE.gif"
3637
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px;" /></kbd>
3738

3839

3940
* *WebSocket (WS)*: Swell enables connecting directly to WebSocket servers with an HTTP handshake. Developers can directly send messages to the connected WS server. Messages are displayed in chatbox format, clearly indicating outgoing and incoming messages.
40-
<kbd><img src="https://i.imgur.com/cyVs9MZ.png"
41+
<kbd><img src="./ReadMeGifs/Swell_API_WebSockets.gif"
42+
style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
43+
44+
45+
* *GraphQL*: Swell includes full support for all three root types of GraphQL - queries, mutations, and subscriptions - with and without variables
46+
<kbd><img src="./ReadMeGifs/Swell_API_GraphQL_Query.gif"
4147
style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
4248

49+
## Additional Features
50+
* *Collections*: Swell allows you to save collections for easier testing of multiple requests.
51+
<kbd><img src="./ReadMeGifs/Swell_API_Collections.gif"
52+
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
53+
54+
55+
* *Minimize/Expand*: Swell allows you to minimize and expand your requests, making it easy to manage everything at once.
56+
<kbd><img src="./ReadMeGifs/Swell_API_Minimize_Expand.gif"
57+
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
58+
4359

4460
## Built With
4561
* Electron
4662
* React
4763
* Redux
64+
* Express
65+
* Apollo
66+
* React-Modal
67+
* IndexedDB
4868
* Chart.js
4969

5070

@@ -54,10 +74,11 @@ Swell is a one-stop shop for sending and monitoring your API requests
5474
* **Brandon Marrero** - [brandon6190](https://github.com/brandon6190)
5575
* **Jason Ou** - [jasonou1994](https://github.com/jasonou1994)
5676
* **Kyle Combs** - [texpatnyc](https://github.com/texpatnyc)
77+
* **Kwadwo Asamoah** - [addoasa](https://github.com/addoasa)
78+
* **Abby Chao** - [brandon6190](https://github.com/abbychao)
79+
* **Amanda Flink** - [jasonou1994](https://github.com/aflinky)
80+
* **Kajol Thapa** - [texpatnyc](https://github.com/kajolthapa)
5781

5882
## License
5983

60-
This project is licensed under the MIT License.
61-
<!--
62-
C:\Users\Lazarus-Kwadwo\Desktop\devStuff\codesmith\production\Swell\node_modules\jest-jasmine2\package.json.4242575574
63-
C:\Users\Lazarus-Kwadwo\Desktop\devStuff\codesmith\production\Swell\node_modules\jest-jasmine2\package.json -->
84+
This project is licensed under the MIT License
9.31 MB
Loading

ReadMeGifs/Swell_API_3_SSE.gif

3.7 MB
Loading
Loading
6.47 MB
Loading

ReadMeGifs/Swell_API_Collections.gif

13.3 MB
Loading
4.4 MB
Loading
3.04 MB
Loading

ReadMeGifs/Swell_API_SSE.gif

8.69 MB
Loading

ReadMeGifs/Swell_API_WebSockets.gif

8.83 MB
Loading

0 commit comments

Comments
 (0)