https://github.com/gr2m/octokit-plugin-hello-world

Simple Octokit.js plugin for demo purposes
https://github.com/gr2m/octokit-plugin-hello-world

Last synced: about 1 year ago
JSON representation

Simple Octokit.js plugin for demo purposes

• Host: GitHub
• URL: https://github.com/gr2m/octokit-plugin-hello-world
• Owner: gr2m
• License: mit
• Created: 2019-10-12T07:13:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-08T11:53:21.000Z (almost 3 years ago)
• Last Synced: 2025-06-15T15:33:29.842Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://pkg.fyi/octokit-plugin-hello-world
• Size: 951 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# octokit-plugin-hello-world

> Simple Octokit.js plugin for demo purposes

[![@latest](https://img.shields.io/npm/v/octokit-plugin-hello-world.svg)](https://www.npmjs.com/package/octokit-plugin-hello-world)

[![Build Status](https://github.com/gr2m/octokit-plugin-hello-world/workflows/Test/badge.svg)](https://github.com/gr2m/octokit-plugin-hello-world/actions?workflow=Test)

[![Greenkeeper](https://badges.greenkeeper.io/gr2m/octokit-plugin-hello-world.svg)](https://greenkeeper.io/)

## Usage

Browsers

Load `octokit-plugin-hello-world` and [`@octokit/core`](https://github.com/octokit/core.js) (Or others such as [`@octokit/rest`](https://github.com/octokit/rest.js)) directly from [cdn.pika.dev](https://cdn.pika.dev)

```html

  import { Octokit } from "https://cdn.pika.dev/@octokit/core";

  import { helloWorld } from "https://cdn.pika.dev/octokit-plugin-hello-world";

```

Node

Install with npm install octokit-plugin-hello-world

```js

const { Octokit } = require("@octokit/core");

const { helloWorld } = require("octokit-plugin-hello-world");

```

```js

const MyOctokit = Octokit.plugin(helloWorld);

const octokit = new MyOctokit();

octokit.helloWorld();

// logs "Hello, world!

```

See [`@octoki/core`](https://github.com/octokit/core.js) for available APIs to create more advanced plugins.

## License

[MIT](LICENSE)