From 53037019879e17365643317ecd0853331bb5ae8c Mon Sep 17 00:00:00 2001 From: HamzaBoukraa <15948623+HamzaBoukraa@users.noreply.github.com> Date: Wed, 24 Jun 2020 17:15:19 +0200 Subject: [PATCH] Update readme.md Including the content of About page of https://docs.webhook.site/ in the readme.md so that Developers would have an idea wbout what is Webhook.site without any further clicks --- readme.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 6fd8a85..ba98b0b 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,34 @@ -# Webhook.site +# [Webhook.site](https://webhook.site) [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/fredsted/webhook.site.svg)](https://hub.docker.com/r/fredsted/webhook.site) [![GitHub last commit](https://img.shields.io/github/last-commit/fredsted/webhook.site.svg)](https://github.com/fredsted/webhook.site/commits/master) -With Webhook.site, you can easily test HTTP webhooks and other types of HTTP requests. +With [Webhook.site](https://webhook.site), you instantly get a unique, random URL that you can use to test and debug Webhooks and HTTP requests, as well as to create your own workflows using the Custom Actions graphical editor or WebhookScript, a simple scripting language, to transform, validate and process HTTP requests. -Upon visiting the app, you get a random URL to send your requests and webhooks to, and they're all logged in the app – instantly. Check it out at [https://webhook.site](https://webhook.site). +## What are people using it for? -**[Documentation at docs.webhook.site](https://docs.webhook.site)** +* Receive Webhooks without needing an internet-facing Web server +* Send Webhooks to a server that’s behind a firewall or private subnet +* Transforming Webhooks into other formats, and re-sending them to different systems +* Connect different APIs that aren’t compatible +* Building contact forms that send emails +* Instantly build APIs without needing infrastructure +Built by Simon Fredsted (@fredsted). + +## Open Source + +There are two versions of Webhook.site: + +* The completely open-source, MIT-licensed version is available on Github, which can be self-hosted using e.g. Docker, is great for testing Webhooks, but doesn’t include features like Custom Actions. + +* The cloud version at [https://webhook.site](https://webhook.site) which has more features, some of them requiring a paid subscription. + +## Acknowledgements + +* The app was built with [Laravel](https://laravel.com) for the API and Angular.js for the frontend SPA. +* WebhookScript based on [Primi](https://github.com/smuuf/Primi) Copyright (c) Přemysl Karbula. +* The WebhookScript editor is using the [Ace](https://ace.c9.io/). +* JSONPath extraction provided by [FlowCommunications](https://github.com/FlowCommunications/JSONPath). +* This documentation site uses [Just the Docs](https://github.com/pmarsceill/just-the-docs), a documentation theme for Jekyll. + +**[Full Documentation at docs.webhook.site](https://docs.webhook.site)**