Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 2.41 KB

README.md

File metadata and controls

81 lines (59 loc) · 2.41 KB

🎯 Sankaku Client

Unofficial Sankaku Beta API Client with Account Support

🚀 Quick Start

Prerequisites

  • Node.js >=14

Installation

# use npm or your preferred package manager like bun!
npm install sankaku-client

Example usage

import Client from 'sankaku-client';

const client = new Client();

client.searchSubmissions({
  limit: 1,
  order_by: 'random'
})
.then((response) => {
  console.log(response[0]);
});

For comprehensive documentation, please visit our Wiki.

🗺️ Roadmap

  • Upload functionality
  • Comment system implementation

🤝 Contributing

We welcome contributions! Here's how you can help:

  • Check out our issues page
  • Submit bug reports or feature requests
  • Create pull requests
  • Improve documentation

⭐ Support

If you find this project useful, please consider giving it a star on GitHub! It helps others discover this project.

📝 License

Copyright © 2021-2024 GiorgioBrux

This project is licensed under the MIT License.