# project-discovery-announce

> Announce the state of an in-progress project to share for humans.

Latest version **0.3.0** (published 2016-11-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install project-discovery-announce
pnpm add project-discovery-announce
yarn add project-discovery-announce
bun add project-discovery-announce
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-11-20 |
| First published | 2016-05-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jack Bennett |
| Maintainers | jackbennett |
| Keywords | post, announce, share |

## Links

- npm: https://www.npmjs.com/package/project-discovery-announce
- Repository: https://github.com/Jackbennett/project-discovery
- Homepage: https://github.com/Jackbennett/project-discovery#readme
- Issues: https://github.com/Jackbennett/project-discovery/issues
- npm.io page: https://npm.io/package/project-discovery-announce

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.13.1

## Recent versions

- 0.3.0 (latest) — 2016-11-20
- 0.2.0 — 2016-05-26

## README

# Project Discovery Announcer

This module sends a POST message about your project that just started running and the url to view it.
A server listening for this message can print this title and url onto a page for other users to find.

This is for environments where users (students) can be stopping/starting their work constantly and from a variety of computers which makes a fixed address impractical.
Use the server component to host a page for students to find each others work online during a lesson.
It's designed so a class can just focus on creating their own work but easily find their classmates in-progress work to view.

The server component can be found on [github](https://github.com/Jackbennett/project-discovery) where this module is also included.

# Usage
Just require the module with the URL path to a server it should send status messages to. Then announce your project is available with an object containing some information.

```javascript
var announce = require('project-discovery-announce')('http://api.example.com/announce')

// ... Application code here

server.listen(port, hostname, () => {
    console.log(`${hostname}:${port} ready.`)
    announce.up({"port": port})
})
```

# Methods
## up([options])
function can accept an object to customize the project title and url that is advertised. If no options are set these will be guessed

available options are;
name | type | default| description
-----|------|--------| -----------
title | string | Formatted URL value | What title to display on the page
hostname | string | computer name | Guessed from the current system name
port | number | 3000 | the port to access your project on
url | string | guessed from port and hostname | Override to an exact url you choose

```javascript
{
    'title': 'Test Site A',
    'hostname': 'computername',
    'port': 8080,
    'url': 'http://example.com'
}
```

---
_Source: https://npm.io/package/project-discovery-announce · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._