mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2025-09-01 18:20:06 +00:00
Fix readme image tags, use more prominent headers (#12)
This commit is contained in:
Suchintan
GitHub
parent
6b51717f3d
commit
099f67cbbe
1 changed files with 43 additions and 46 deletions
89
README.md
89
README.md
|
|
@ -1,9 +1,9 @@
|
|||
<h1 align="center">
|
||||
<a href="https://www.skyvern.com">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="images/skyvern_logo.png">
|
||||
<img height="120" src="images/skyvern_logo.png">
|
||||
</picture>
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="images/skyvern_logo.png"/>
|
||||
<img height="120" src="images/skyvern_logo.png"/>
|
||||
</picture>
|
||||
</a>
|
||||
<br />
|
||||
</h1>
|
||||
|
|
@ -11,29 +11,29 @@
|
|||
🐉 Automate Browser-based workflows using LLMs and Computer Vision 🐉
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://www.skyvern.com/"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=black"></a>
|
||||
<a href="https://docs.skyvern.com/"><img src="https://img.shields.io/badge/Docs-yellow?logo=gitbook&logoColor=black"></a>
|
||||
<a href="https://discord.gg/fG2XXEuQX3"><img src="https://img.shields.io/discord/1212486326352617534?logo=discord&label=discord"></a>
|
||||
<a href="https://www.skyvern.com/"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=black"/></a>
|
||||
<a href="https://docs.skyvern.com/"><img src="https://img.shields.io/badge/Docs-yellow?logo=gitbook&logoColor=black"/></a>
|
||||
<a href="https://discord.gg/fG2XXEuQX3"><img src="https://img.shields.io/discord/1212486326352617534?logo=discord&label=discord"/></a>
|
||||
<!-- <a href="https://pepy.tech/project/skyvern" target="_blank"><img src="https://static.pepy.tech/badge/skyvern" alt="Total Downloads"/></a> -->
|
||||
<a href="https://github.com/skyvern-ai/skyvern"><img src="https://img.shields.io/github/stars/skyvern-ai/skyvern" /></a>
|
||||
<a href="https://www.linkedin.com/company/95726232"><img src="https://img.shields.io/github/license/skyvern-ai/skyvern"></a>
|
||||
<a href="https://twitter.com/skyvernai"><img src="https://img.shields.io/twitter/follow/skyvernai?style=social"></a>
|
||||
<a href="https://www.linkedin.com/company/95726232"><img src="https://img.shields.io/badge/Follow%20 on%20LinkedIn-8A2BE2?logo=linkedin"></a>
|
||||
<a href="https://www.linkedin.com/company/95726232"><img src="https://img.shields.io/github/license/skyvern-ai/skyvern"/></a>
|
||||
<a href="https://twitter.com/skyvernai"><img src="https://img.shields.io/twitter/follow/skyvernai?style=social"/></a>
|
||||
<a href="https://www.linkedin.com/company/95726232"><img src="https://img.shields.io/badge/Follow%20 on%20LinkedIn-8A2BE2?logo=linkedin"/></a>
|
||||
</p>
|
||||
|
||||
[Skyvern](https://www.skyvern.com) automates browser-based workflows using LLMs and computer vision. It provides a simple API endpoint to fully automate manual workflows, replacing brittle or unreliable automation solutions.
|
||||
|
||||
<p align="center">
|
||||
<img src="images/geico_shu_recording_cropped.gif">
|
||||
<img src="images/geico_shu_recording_cropped.gif"/>
|
||||
</p>
|
||||
|
||||
Want to see more examples of Skyvern in action? Click [here](#real-world-examples-of-skyvern-in-action)!
|
||||
|
||||
|
||||
## Quickstart
|
||||
# Quickstart
|
||||
This quickstart guide will walk you through getting Skyvern up and running on your local machine.
|
||||
|
||||
### Prerequisites
|
||||
## Prerequisites
|
||||
Before you begin, make sure you have the following installed:
|
||||
|
||||
- [Brew (if you're on a Mac)](https://brew.sh/)
|
||||
|
|
@ -44,7 +44,7 @@ Before you begin, make sure you have the following installed:
|
|||
- [PostgreSQL 14](https://www.postgresql.org/download/) (if you're on a Mac, setup script will install it for you if you have homebrew installed)
|
||||
- `brew install postgresql`
|
||||
|
||||
### Setup
|
||||
## Setup
|
||||
1. Clone the repository and navigate to the root directory
|
||||
1. Run the setup script to install the necessary dependencies and setup your environment
|
||||
```bash
|
||||
|
|
@ -64,19 +64,42 @@ Before you begin, make sure you have the following installed:
|
|||
```
|
||||
1. Navigate to `http://localhost:8501` in your browser to start using the UI
|
||||
|
||||
### Additional Setup for Contributors
|
||||
## Additional Setup for Contributors
|
||||
If you're looking to contribute to Skyvern, you'll need to install the pre-commit hooks to ensure code quality and consistency. You can do this by running the following command:
|
||||
```bash
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
|
||||
# Real-world examples of Skyvern
|
||||
We love to see how Skyvern is being used in the wild. Here are some examples of how Skyvern is being used to automate workflows in the real world. Please open PRs to add your own examples!
|
||||
|
||||
|
||||
## Automate materials procurement for a manufacturing company
|
||||
<p align="center">
|
||||
<img src="images/finditparts_recording_crop.gif"/>
|
||||
</p>
|
||||
|
||||
## Navigating to government websites to register accounts or fill out forms
|
||||
<p align="center">
|
||||
<img src="images/edd_services.gif"/>
|
||||
</p>
|
||||
|
||||
## Retrieving insurance quotes from insurance providers in any language
|
||||
<p align="center">
|
||||
<img src="images/bci_seguros_recording.gif"/>
|
||||
</p>
|
||||
<p align="center">
|
||||
<img src="images/geico_shu_recording_cropped.gif"/>
|
||||
</p>
|
||||
|
||||
<!---
|
||||
[## Documentation]
|
||||
|
||||
More extensive documentation can be found on our [documentation website](https://docs.skyvern.ai). Please let us know if something is unclear or missing by opening an issue or reaching out to us [via email](mailto:founders@skyvern.com) or [discord](https://discord.gg/fG2XXEuQX3).
|
||||
--->
|
||||
|
||||
## Frequently Asked Questions (FAQs)
|
||||
# Frequently Asked Questions (FAQs)
|
||||
### What gets us excited about Skyvern?
|
||||
|
||||
Our focus is bringing stability to browser-based workflows. We leverage LLMs to create an AI Agent capable of interacting with websites like you or I would — all via a simple API call.
|
||||
|
|
@ -95,7 +118,7 @@ This approach gives us a few advantages:
|
|||
1. If you were doing competitor analysis, it’s understanding that an Arnold Palmer 22 oz can at 7/11 is almost definitely the same product as a 23 oz can at Gopuff (even though the sizes are slightly different, which could be a rounding error!)
|
||||
|
||||
|
||||
## Feature Roadmap
|
||||
# Feature Roadmap
|
||||
This is our planned roadmap for the next few months. If you have any suggestions or would like to see a feature added, please don't hesitate to reach out to us [via email](mailto:founders@skyvern.com) or [discord](https://discord.gg/fG2XXEuQX3).
|
||||
|
||||
- [x] **Open Source** - Open Source Skyvern's core codebase
|
||||
|
|
@ -110,43 +133,17 @@ This is our planned roadmap for the next few months. If you have any suggestions
|
|||
- [ ] **Integrate public datasets** - Integrate Skyvern with public benchmark tests to track the quality our models over time
|
||||
- [ ] **Workflow UI Builder** - Introduce a UI to allow users to build and analyze workflows visually
|
||||
|
||||
## Contributing
|
||||
# Contributing
|
||||
|
||||
We welcome PRs and suggestions! Don't hesitate to open a PR/issue or to reach out to us [via email](mailto:founders@skyvern.com) or [discord](https://discord.gg/fG2XXEuQX3).
|
||||
Please have a look at our [contribution guide](CONTRIBUTING.md) and
|
||||
["Help Wanted" issues](https://github.com/skyvern-ai/skyvern/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) to get started!
|
||||
|
||||
### Telemetry
|
||||
# Telemetry
|
||||
|
||||
By Default, Skyvern collects basic usage statistics to help us understand how Skyvern is being used. If you would like to opt-out of telemetry, please set the `SKYVERN_TELEMETRY` environment variable to `false`.
|
||||
|
||||
## License
|
||||
# License
|
||||
Skyvern's open source repository is supported via a managed cloud. All of the core logic powering Skyvern is available in this open source repository licensed under the [AGPL-3.0 License](LICENSE), with the exception of anti-bot measures available in our managed cloud offering.
|
||||
|
||||
If you have any questions or concerns around licensing, please [contact us](mailto:founders@skyvern.com) and we would be happy to help.
|
||||
|
||||
|
||||
## Real-world examples of Skyvern in action
|
||||
We love to see how Skyvern is being used in the wild. Here are some examples of how Skyvern is being used to automate workflows in the real world. Please open PRs to add your own examples!
|
||||
|
||||
|
||||
### Automate materials procurement for a manufacturing company
|
||||
<p align="center">
|
||||
<img src="images/finditparts_recording_crop.gif">
|
||||
</p>
|
||||
|
||||
### Navigating to government websites to register accounts or fill out forms
|
||||
<p align="center">
|
||||
<img src="images/edd_services.gif">
|
||||
</p>
|
||||
|
||||
### Retrieving insurance quotes from insurance providers in any language
|
||||
<p align="center">
|
||||
<img src="images/bci_seguros_recording.gif">
|
||||
</p>
|
||||
<p align="center">
|
||||
<img src="images/geico_shu_recording_cropped.gif">
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue