https://github.com/bukinoshita/gh-polls

Create a poll with gh-polls
https://github.com/bukinoshita/gh-polls

apex gh gh-poll gh-polls poll polls up

Last synced: 2 months ago
JSON representation

Create a poll with gh-polls

• Host: GitHub
• URL: https://github.com/bukinoshita/gh-polls
• Owner: bukinoshita
• License: mit
• Created: 2017-11-03T14:23:43.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T01:45:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T16:07:30.503Z (3 months ago)
• Topics: apex, gh, gh-poll, gh-polls, poll, polls, up
• Language: TypeScript
• Homepage:
• Size: 1.23 MB
• Stars: 45
• Watchers: 3
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# gh-polls

> Create a poll with gh-polls

## Install

```bash

$ yarn add gh-polls

```

## Usage

```js

import { ghPolls } from 'gh-polls'

const options = ['Tobi', 'Loki', 'Jane']

await ghPolls(options)

```

[![](https://api.gh-polls.com/poll/01BM2ZHFZXYKQV9N3HNFXCBH3N/Tobi)](https://api.gh-polls.com/poll/01BM2ZHFZXYKQV9N3HNFXCBH3N/Tobi/vote)

[![](https://api.gh-polls.com/poll/01BM2ZHFZXYKQV9N3HNFXCBH3N/Loki)](https://api.gh-polls.com/poll/01BM2ZHFZXYKQV9N3HNFXCBH3N/Loki/vote)

[![](https://api.gh-polls.com/poll/01BM2ZHFZXYKQV9N3HNFXCBH3N/Jane)](https://api.gh-polls.com/poll/01BM2ZHFZXYKQV9N3HNFXCBH3N/Jane/vote)

## About



`gh-polls (js)` is a node module that returns an `object` with 3 keys `text`, `vote` and `image`. [Tj](https://github.com/tj) created [gh-polls (go)](https://github.com/apex/gh-polls) to be able to use polls on GitHub. With `gh-polls (js)` you can create polls outside GitHub, for example on your own website.

## API

### ghPolls([options])

Returns a `promise`

#### options

Type: `array`

Required

Array of options (string).

## Related

- [apex/gh-polls](https://github.com/apex/gh-polls) – polls for user feedback in GitHub issues

- [apex/up](https://github.com/apex/up) – the serverless webapp tool powering gh-polls

- [Web App](https://app.gh-polls.com/) – GH polls web app

- [GitHub App](https://github.com/apps/polls) – GH polls bot

## License

MIT © [Bu Kinoshita](https://bukinoshita.com)