From a858cb8970e513737d308d20b2e082b163eb43fc Mon Sep 17 00:00:00 2001 From: Prathamesh Pawar <163292716+PrathameshSPawar@users.noreply.github.com> Date: Sun, 27 Oct 2024 13:51:37 +0530 Subject: [PATCH] (typo):I've made some corrections to your Documentation I have made some corrections to your repository to help clarify certain aspects. These improvements aim to enhance the overall understanding and usability of the project. I hope they contribute positively to your work! --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dd8a740ae..0b73cf756 100644 --- a/README.md +++ b/README.md @@ -35,21 +35,21 @@ # 🔥 Firecrawl -Empower your AI apps with clean data from any website. Featuring advanced scraping, crawling, and data extraction capabilities. +Empower your AI applications with clean data from any website. Featuring advanced scraping, crawling, and data extraction capabilities. -_This repository is in development, and we’re still integrating custom modules into the mono repo. It's not fully ready for self-hosted deployment yet, but you can run it locally._ +_This repository is in development, and we’re still integrating custom modules into the mono repo. It's not fully ready for a self-hosted deployment yet, but you can run it locally._ ## What is Firecrawl? -[Firecrawl](https://firecrawl.dev?ref=github) is an API service that takes a URL, crawls it, and converts it into clean markdown or structured data. We crawl all accessible subpages and give you clean data for each. No sitemap required. Check out our [documentation](https://docs.firecrawl.dev). +[Firecrawl](https://firecrawl.dev?ref=github) is an API service that accepts a URL, crawls it, and converts it into clean markdown or structured data. We crawl all accessible subpages and give you clean data for each. No sitemap required. Check out our [documentation](https://docs.firecrawl.dev). _Pst. hey, you, join our stargazers :)_ - GitHub stars + GitHub Stars: -## How to use it? +## How to Use it? We provide an easy to use API with our hosted version. You can find the playground and documentation [here](https://firecrawl.dev/playground). You can also self host the backend if you'd like. @@ -214,7 +214,7 @@ Response: #### Map with search -Map with `search` param allows you to search for specific urls inside a website. +Map with `search` parameter allows you to search for specific URLs inside a website. ```bash cURL curl -X POST https://api.firecrawl.dev/v1/map \ @@ -324,7 +324,7 @@ curl -X POST https://api.firecrawl.dev/v1/scrape \ ### Interacting with the page with Actions (Cloud-only) -Firecrawl allows you to perform various actions on a web page before scraping its content. This is particularly useful for interacting with dynamic content, navigating through pages, or accessing content that requires user interaction. +Firecrawl enables you to perform various actions on a web page before scraping its content. This is particularly useful for interacting with dynamic content, navigating through pages, or accessing content that requires user interaction. Here is an example of how to use actions to navigate to google.com, search for Firecrawl, click on the first result, and take a screenshot.