Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 2.81 KB

README.md

File metadata and controls

74 lines (53 loc) · 2.81 KB
Raw

stars license supportServer forks issues

Logo

Get Pinned Repos

Get anyones pinned GitHub repositories easily.
Get support »

Report Bug · Request Feature · Webpage

✨ Get Pinned Repos

Get anyones pinned GitHub repositories easily.

📦 Installation

  • Using yarn: yarn add get-pinned-repos
  • Using npm: npm i get-pinned-repos

🤓 Usage

import { Client } from "get-pinned-repos";
// or
const { Client } = require("get-pinned-repos");

Client.setToken("YOUR GITHUB TOKEN (MAKE SURE IT HAS ADMIN PRIVILIGES)");
const pinned = await Client.getPinnedRepos("barbarbar338");

console.log(pinned); // IPinnedRepo[]

See https://github.com/barbarbar338/get-pinned-repos/blob/main/src/types.ts for more detailed typings.

📄 License

Copyright © 2021 Barış DEMİRCİ.

Distributed under the MIT License. See LICENSE for more information.

🧦 Contributing

Feel free to use GitHub's features.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/my-feature)
  3. Run prettier and eslint (npm run format && npm run lint)
  4. Commit your Changes (git commit -m 'my awesome feature my-feature')
  5. Push to the Branch (git push origin feature/my-feature)
  6. Open a Pull Request

🔥 Show your support

Give a ⭐️ if this project helped you!

📞 Contact