bruno/readme.md

69 lines
2.7 KiB
Markdown
Raw Normal View History

<br />
<img src="assets/images/logo-transparent.png" width="80"/>
2022-10-21 15:11:28 +02:00
2023-10-02 10:17:14 +02:00
### Bruno - Opensource IDE for exploring and testing APIs.
2023-01-29 19:58:42 +01:00
[![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)
[![Commit Activity](https://img.shields.io/github/commit-activity/m/usebruno/bruno)](https://github.com/usebruno/bruno/pulse)
[![Twitter](https://img.shields.io/twitter/follow/use_bruno?style=social&logo=twitter)](https://twitter.com/use_bruno)
[![Website](https://img.shields.io/badge/Website-Visit-blue)](https://www.usebruno.com)
2023-01-29 20:13:30 +01:00
[![Download](https://img.shields.io/badge/Download-Latest-brightgreen)](https://www.usebruno.com/downloads)
2023-01-29 19:58:42 +01:00
Bruno is a new and innovative API client, aimed at revolutionizing the status quo represented by Postman and similar tools out there.
2023-01-29 20:09:39 +01:00
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.
2023-01-22 01:30:00 +01:00
You can use git or any version control of your choice to collaborate over your API collections.
2023-01-29 19:58:42 +01:00
2023-10-02 10:17:14 +02:00
Bruno is offline-only. There are no plans to add cloud-sync to Bruno, Ever. We believe that your data is yours and should be stored on your machine.
If you are interested to know more about our long term vision, we recently penned some thoughts [here](https://github.com/usebruno/bruno/discussions/269)
2023-01-29 19:58:42 +01:00
2023-01-29 20:09:39 +01:00
![bruno](assets/images/landing-2.png) <br /><br />
2022-10-23 19:10:26 +02:00
2023-03-30 07:26:37 +02:00
### Run across multiple platforms 🖥️
2023-10-02 10:17:14 +02:00
2023-03-30 07:26:37 +02:00
![bruno](assets/images/run-anywhere.png) <br /><br />
### Collaborate via Git 👩‍💻🧑‍💻
2023-10-02 10:17:14 +02:00
2023-03-30 07:26:37 +02:00
Or any version control system of your choice
![bruno](assets/images/version-control.png) <br /><br />
2023-02-08 12:17:52 +01:00
### Website 📄
2023-10-02 10:17:14 +02:00
2023-02-08 12:17:52 +01:00
Please visit [here](https://www.usebruno.com) to checkout our website and download the app
2023-01-29 20:09:39 +01:00
### Documentation 📄
2023-10-02 10:17:14 +02:00
2023-01-29 20:09:39 +01:00
Please visit [here](https://docs.usebruno.com) for documentation
2023-01-24 17:14:33 +01:00
2022-10-21 15:11:28 +02:00
### Contribute 👩‍💻🧑‍💻
2023-10-02 10:17:14 +02:00
2022-10-21 15:11:28 +02:00
I am happy that you are looking to improve bruno. Please checkout the [contributing guide](contributing.md)
Even if you are not able to make contributions via code, please don't hesitate to file bugs and feature requests that needs to be implemented to solve your use case.
2023-10-02 10:17:14 +02:00
### Support ❤️
2022-10-23 19:10:26 +02:00
Woof! If you like project, hit that ⭐ button !!
### Authors
<div align="center">
<a href="https://github.com/usebruno/bruno/graphs/contributors">
<img src="https://contrib.rocks/image?repo=usebruno/bruno" />
</a>
</div>
2022-10-16 10:21:10 +02:00
### Stay in touch 🌐
2023-10-02 10:17:14 +02:00
2022-10-21 15:11:28 +02:00
[Twitter](https://twitter.com/use_bruno) <br />
[Website](https://www.usebruno.com) <br />
[Discord](https://discord.com/invite/KgcZUncpjq)
2022-10-16 10:21:10 +02:00
### License 📄
2023-10-02 10:17:14 +02:00
2022-10-21 15:11:28 +02:00
[MIT](license.md)