Skip to content

Commit 18788e2

Browse files
committed
add new quick start section
1 parent c552e8e commit 18788e2

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

Diff for: README.md

+43-4
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@ Many users will likely prefer alternative ways to use the platform rather than w
2727
- [Web tools](#web-based-tools---globalping-website) for on-the-go testing and visual presentations
2828
- [Slack app](#slack-app) for bringing network testing capabilities into your Slack workspace
2929
- [GitHub bot](#github-bot) for adding network test results to public GitHub issues
30+
- [Find more integrations on our website](https://www.jsdelivr.com/globalping/integrations)
3031

31-
Discover more about Globalping on our website [www.jsdelivr.com/globalping](https://www.jsdelivr.com/globalping)
32+
Learn more about Globalping on [www.jsdelivr.com/globalping](https://www.jsdelivr.com/globalping)
3233

33-
## Our major donors
34-
We thank our donors who contribute to the development of Globalping and help us expand our probe network!
34+
## Our major sponsors
35+
We thank our sponsors who contribute to the development of Globalping and help us expand our probe network!
3536

3637
| <img src="https://gcore.com/favicon.ico" width="15" height="15"> [Gcore](https://gcore.com) | <img src="https://xtom.com/favicon.ico" width="15" height="15"> [xTom](https://xtom.com) | <img src="https://www.edisglobal.com/favicon.png" width="15" height="15"> [Edis Global](https://www.edisglobal.com) |
3738
|---|---|---|
@@ -44,7 +45,45 @@ Here are some ways you can help:
4445
- [Become a GitHub sponsor](https://www.jsdelivr.com/sponsors): By becoming a GitHub sponsor of [jsDelivr](https://github.com/jsdelivr), you are supporting both the jsDelivr CDN and the Globalping platform. Sponsors contributing $10 or more per month can request a hardware probe to install in their home or office.
4546
- [Become a hardware probe provider](https://docs.google.com/document/d/1xIe-BaZ-6mmkjN1yMH5Kauw3FTXADrB79w4pnJ4SLa4/edit#heading=h.tmcgof2zm3yh): Sponsor a batch of co-branded hardware probes, including your own stickers and swag, to ship to your users or hand out at conferences.
4647

47-
## Get started writing tests
48+
### Web-based tools
49+
Our web form is perfect for users who prefer to work with UIs or want to run tests from any device with a browser.
50+
51+
Follow these steps to create your test:
52+
1. Head to [our website](https://www.jsdelivr.com/globalping)
53+
2. Use the form at the top of the page to configure the test case:
54+
1. Test type: ping
55+
2. Target: google.com
56+
3. Location: New York
57+
4. Limit: 1
58+
3. Click "Run Test"
59+
4. View the used probe in New York on the map below the form and review the ping result beneath the map:
60+
61+
### CLI tool
62+
If you prefer to work from your terminal, the CLI tool is the ideal choice for using Globalping.
63+
64+
Follow these steps to create the test:
65+
1. Install the CLI using your favorite package manager as described [here](#globalping-cli)
66+
2. Test if everything works by running `globalping --help`
67+
3. Write and run the test case described above:
68+
1. `globalping ping google.com from New York`
69+
4. Instantly review the ping result:
70+
71+
```
72+
$ globalping ping google.com from New York
73+
> NA, US, (NY), New York, ASN:63473, HostHatch, LLC
74+
> PING (142.251.40.142) 56(84) bytes of data.
75+
64 bytes from lga25s80-in-f14.1e100.net (142.251.40.142): icmp_seq=1 ttl=57 time=1.73 ms
76+
64 bytes from lga25s80-in-f14.1e100.net (142.251.40.142): icmp_seq=2 ttl=57 time=1.64 ms
77+
64 bytes from lga25s80-in-f14.1e100.net (142.251.40.142): icmp_seq=3 ttl=57 time=1.66 ms
78+
79+
--- ping statistics ---
80+
3 packets transmitted, 3 received, 0% packet loss, time 402ms
81+
rtt min/avg/max/mdev = 1.641/1.679/1.733/0.039 ms
82+
```
83+
84+
There's so much more you can do with Globalping! Learn the basics, discover more integrations for different use cases, and tips to help you get the most out of our platform.
85+
86+
## How to write networking tests with Globalping
4887
While we offer [different tools and integrations](#available-globalping-tools-and-integrations) for running tests with Globalping, we make sure that they provide a consistent experience. This also means that writing tests looks almost identical whether you're using the CLI tool or the Slack app, for example.
4988

5089
Follow this structure when writing tests:

0 commit comments

Comments
 (0)