Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
hartym authored Feb 1, 2024
1 parent bb9393e commit 2dff50c
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
HARP – Harp, an API Runtime Proxy
=================================

HARP is a sidecar proxy service raising reliability, performances, security and observability of your application's
external API usage. It can be seen as a revers API gateway, or a nearline service mesh for external API.
HARP is a powerful sidecar proxy service designed to elevate the reliability, performance, security, and observability
of your application's external API interactions. Think of it as a reverse API gateway or a nearline service mesh for
external APIs.

.. image:: docs/images/how-it-works.png

* It integrates with your application in a few minutes: run it, change your API endpoints and you're good to go.
* As a nearline proxy, the network distance between your application and external services is lowered to the minimum.
* Caching, monitoring, alerting, rate limiting, circuit breaking, retries, tracing, logging, etc. can be delegated to
the proxy, greatly reducing the amount of (hard) code you need to write.
* It speak HTTP, so the integration (or removal) cost is barely 0 (or negative, if you consider all code you won't need
to write).
* Easy Integration: With HARP, integrating with your application is a breeze. Simply run the proxy, update your API
endpoints, and you're ready to go. No complex setup or extensive configuration required.
* Reduced Network Distance: As a nearline proxy, HARP minimizes the network distance between your application and
external services. This optimization leads to faster response times and improved overall performance.
* Simplified Development: HARP eliminates the need for writing extensive code for functionalities such as caching,
monitoring, alerting, rate limiting, circuit breaking, retries, tracing, logging, and more. These features can be
easily delegated to the proxy, reducing the amount of code you need to write and maintain.
* Seamless HTTP Integration: HARP seamlessly integrates with your application using the HTTP protocol. This means
that the integration or removal cost is virtually zero, or even negative when considering the reduction in code you
won't need to write.

0 comments on commit 2dff50c

Please sign in to comment.