Skip to content

Commit df5e49b

Browse files
committed
feat: add README.md with project overview and usage instructions
1 parent 0171e5a commit df5e49b

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Namecheap API Project
2+
3+
The Namecheap API allow developers to easily interact with Namecheap's domain registration and management services. The goal is to provide a simple and intuitive interface for performing common tasks such as registering domains, managing DNS settings, and handling SSL certificates.
4+
5+
## Features
6+
7+
- Domain registration and renewal
8+
- DNS management
9+
- SSL certificate management
10+
- Account balance and transaction history
11+
12+
## Installation
13+
14+
To install the package, use the following command:
15+
16+
```bash
17+
npm install namecheap-api
18+
```
19+
20+
## Usage
21+
22+
Here is a basic example of how to use the API:
23+
24+
```javascript
25+
import { NameCheap } from "namecheap-api";
26+
(async () => {
27+
const namecheap = new NameCheap({
28+
apiKey: "<...api key...>",
29+
apiUser: "user",
30+
clientIP: "127.0.0.1",
31+
username: "user",
32+
});
33+
34+
const res = await namecheap.query("domains.dns.getHosts", {
35+
SLD: "example",
36+
TLD: "com",
37+
});
38+
39+
console.log(res.ApiResponse.CommandResponse.DomainDNSGetHostsResult);
40+
})();
41+
```
42+
43+
## License
44+
45+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)