Skip to content

README.md

Latest commit

 

History

History
65 lines (48 loc) · 2.32 KB

README.md

File metadata and controls

65 lines (48 loc) · 2.32 KB
HMS.js logo

📦 A modern module for HostMyServers API, streamlining interactions with users, products, and VPS.

Features

  • See and manage your user details 👨‍💻
  • See and manage your products 📦
  • Soon: See and manage your VPS 🖥️

Get my API key 👷

You can get a free API key of your profile on HMS website!

Documentation 📝

You can access to the documentation on the "wiki" part of the GitHub or by clicking to this link!

Example 💡

  1. First of all, don't forget to install the module!
npm install hostmyservers.js@latest
  1. Enjoy!
const { HMSClient } = require('hostmyservers.js');

const client = new HMSClient(apiKey);

client.user.getLastName()
  .then(data => console.log(data))
  .catch(error => console.error('Error fetching user details:', error));

Contributing 🤝

  1. Fork the original repository by clicking the “Fork” button at the top right of the repository page.

  2. Clone your fork locally: git clone https://github.com/FlanZCode/hostmyservers.js.git

  3. Create a new branch for your changes: git checkout -b my-new-feature

  4. Make your changes in the code.

  5. Commit your changes with a clear message: git commit -m "Description of my changes"

  6. Push your changes to your fork: git push origin my-new-feature

  7. Go to your fork’s page on GitHub and click the “New pull request” button.

  8. Describe your changes and submit the pull request.

Credits 🙏

License 📕

This project is licensed under the MIT License. See the LICENSE file for details.