Skip to content

Commit 71e5c61

Browse files
authored
Revise README for MagicalAPI Python SDK
Updated README to reflect the correct SDK name and improved descriptions for clarity.
1 parent ae1cf65 commit 71e5c61

1 file changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@
2626
<img src="https://raw.githubusercontent.com/magicalapi/magicalapi-python/master/docs/logo.png?raw=true" alt="Logo" width="80" height="80">
2727
</a>
2828

29-
<h3 align="center">MagicalAPI Python Client</h3>
29+
<h3 align="center">MagicalAPI Python SDK</h3>
3030

3131
<p align="center">
32-
An Async and Type Annotated Python Client to Easy Access <a href="https://magicalapi.com">MagicalAPI.com</a> Service.
32+
MagicalAPI Python SDK lets developers integrate AI-powered resume parsing, resume scoring, resume matching, and LinkedIn public data extraction into Python applications.
33+
<a href="https://magicalapi.com">MagicalAPI.com</a>
3334
<br />
3435
<!-- <a href="https://github.com/magicalapi/magicalapi-python"><strong>Explore the docs »</strong></a> -->
3536
<!-- <br /> -->
@@ -46,7 +47,9 @@
4647

4748
## Table of Contents
4849
- [What is MagicalAPI?](#what-is-magicalapi)
50+
- [What you can build](#what-you-can-build)
4951
- [Features](#features)
52+
- [Services](#supported-apis)
5053
- [About the Project](#about-the-project)
5154
- [Getting Started](#getting-started)
5255
- [Usage](#usage)
@@ -63,12 +66,25 @@ It offers services like:
6366
- **LinkedIn Data Extraction**: Scrape and analyze LinkedIn profiles.
6467
- **Career Insights**: Gain AI-driven recommendations for career development.
6568

69+
## What you can build
70+
- Resume parsing pipelines for HR platforms
71+
- Candidate scoring and job matching workflows
72+
- LinkedIn profile enrichment tools
73+
- Recruiting automation systems
74+
- ATS integrations
75+
6676
## Features
6777
- **Resume Parsing**: Parse resumes to extract key information like skills, experience, and education.
6878
- **LinkedIn Profile Scraping**: Extract data from LinkedIn profiles for analysis.
6979
- **Career Insights**: Leverage AI to get actionable career recommendations.
7080
- **Type-Annotated and Async**: Built for modern Python with type hints and asynchronous support.
7181

82+
## Supported APIs
83+
- Resume Parser
84+
- Resume Checker
85+
- Resume Matcher
86+
- LinkedIn Profile Scraper
87+
- LinkedIn Company Scraper
7288

7389
<br>
7490

@@ -78,7 +94,7 @@ It offers services like:
7894

7995
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
8096

81-
This is a Python client that provides easy access to the [MagicalAPI.com][website-url] services, fully type annotated, and asynchronous.
97+
This is a Python client that provides easy access to the [MagicalAPI.com][website-url] services, fully type-annotated and asynchronous.
8298

8399
<!-- `magicalapi`, `magicalapi-python`, `MagicalAPI`, `MagicalAPI Python Client` -->
84100

@@ -100,7 +116,7 @@ This is an example of how you can install the client and use it in your own scri
100116

101117
### Installation
102118

103-
Install package using `pip`
119+
Install the package using `pip`
104120

105121
```bash
106122
pip install magicalapi
@@ -112,7 +128,7 @@ pip install magicalapi
112128

113129
## Usage
114130

115-
here are some samples of how to use the client for each service.
131+
Here are some samples of how to use the client for each service.
116132
At first, you have to create an object of `AsyncClient` like this:
117133

118134
```python

0 commit comments

Comments
 (0)