mirror of
https://github.com/usebruno/bruno.git
synced 2024-11-29 03:13:45 +01:00
chore: updated readme documentation
This commit is contained in:
parent
25883b84fa
commit
27dcf78e73
26
readme.md
26
readme.md
@ -1,11 +1,6 @@
|
|||||||
<p style="display:flex;align-items:center">
|
|
||||||
<img src="assets/images/logo-transparent.png" width="50"/>
|
<img src="assets/images/logo-transparent.png" width="50"/>
|
||||||
<span style="font-size: 42px;display:inline-block;margin-left: 12px">
|
|
||||||
bruno
|
|
||||||
</span>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
### Opensource IDE for exploring and testing api's.
|
### Bruno - Opensource IDE for exploring and testing api's.
|
||||||
|
|
||||||
[![GitHub version](https://badge.fury.io/gh/usebruno%2Fbruno.svg)](https://badge.fury.io/gh/usebruno%bruno)
|
[![GitHub version](https://badge.fury.io/gh/usebruno%2Fbruno.svg)](https://badge.fury.io/gh/usebruno%bruno)
|
||||||
[![CI](https://github.com/usebruno/bruno/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/usebruno/bruno/workflows/unit-tests.yml)
|
[![CI](https://github.com/usebruno/bruno/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/usebruno/bruno/workflows/unit-tests.yml)
|
||||||
@ -17,26 +12,15 @@
|
|||||||
|
|
||||||
Bruno is a new and innovative API client, aimed at revolutionizing the status quo represented by Postman and similar tools out there.
|
Bruno is a new and innovative API client, aimed at revolutionizing the status quo represented by Postman and similar tools out there.
|
||||||
|
|
||||||
Bruno stores your collections directly on folder on your filesystem. We use a plain text markup language, Bru, to save information about API requests.
|
Bruno stores your collections directly in a folder on your filesystem. We use a plain text markup language, Bru, to save information about API requests.
|
||||||
|
|
||||||
You can use git or any version control of your choice to collaborate over your api collections.
|
You can use git or any version control of your choice to collaborate over your api collections.
|
||||||
|
|
||||||
|
|
||||||
![bruno](assets/images/landing-2.png)
|
![bruno](assets/images/landing-2.png) <br /><br />
|
||||||
[Visit Website](https://www.usebruno.com) | [Watch Demo](https://www.youtube.com/watch?v=b_ctmKlEOXg) <br />
|
|
||||||
|
|
||||||
### Our Manifesto
|
### Documentation 📄
|
||||||
It's time for a revolution in API client technology. The status quo, represented by Postman, has become bloated and unwieldy. We refuse to be shoehorned into a proprietary version control system for collaborating on API collections.<br />
|
Please visit [here](https://docs.usebruno.com) for documentation
|
||||||
|
|
||||||
We are an opensource project, rising up against the monopoly of bloated and closed systems. We believe that API collections should be co-located within your source code repository, serving as a living set of examples on how to use the API.<br />
|
|
||||||
|
|
||||||
But we realized that the current tools on the market export collections as giant JSON files (a.k.a ugly blobs), difficult to version control and diff. So we created the Bru Markup language, saving information about your API requests using plain text files.<br />
|
|
||||||
|
|
||||||
With Bruno, collections become first-class citizens, co-located with related information and easily version controlled. We say goodbye to bloated workspaces and global environments, and embrace the benefits of co-location.<br />
|
|
||||||
|
|
||||||
We dream of a world where developers can clone a code repo, get it up and running, use bruno to browse the examples on how to use the api and start playing with it. No more horror stories of "Tim had the collections for the payment-api service, but he left the company last month."<br />
|
|
||||||
|
|
||||||
Join us in our mission to create a better API client for developers. Say goodbye to bloatware and hello to simplicity, efficiency and freedom. Try Bruno today and experience the difference for yourself.<br />
|
|
||||||
|
|
||||||
### Contribute 👩💻🧑💻
|
### Contribute 👩💻🧑💻
|
||||||
I am happy that you are looking to improve bruno. Please checkout the [contributing guide](contributing.md)
|
I am happy that you are looking to improve bruno. Please checkout the [contributing guide](contributing.md)
|
||||||
|
Loading…
Reference in New Issue
Block a user