Thankoss NPM Register

This is the npm register for integrating your open-source projects with thankoss.com.

What is it?

Install this package in your open-source project and then re-publish your project to get Thankoss users to share their anonymous email with you when they install your project.

Installation Instructions

In your OSS package repo install thankoss as a dev dependency.

$ npm install thankoss@latest --save-dev

Setup Instructions

(v1 - Open)

1. Add a postinstall script that runs the thankoss cli with the project id

# package.json
{
  "scripts": {
    "postinstall": thankoss --project-id [projectId - found at https://thankoss.com/projects/list]
  },
  ...
}

2. Bump package version to next minor release. $ npm version minor

3. Add info to README.md about Thankoss requirement. (Optional)

# README.md
...
# Non-Monetary Support
If you would like to support us, but don't feel you can provide monerary support, you can setup a Thankoss account for sharing your annonymous email with us. [https://thankoss.com](https://thankoss.com)
...

4. (optional) Test package with beta version. (Follow this article for instructions.)

Your final package.json file should have the following modifications:

# package.json
{
+  "version": 0.x+1.0
  "scripts": {
+    "postinstall": thankoss --project-id [projectid],
    ...
  },
  "devDependencies": {
+    "thankoss": ^*.*.*,
    ...
  },
  ...
}

(v2 - Forced)

1. Add a postinstall script that runs the thankoss cli with the project id

# package.json
{
  "scripts": {
    "postinstall": thankoss --force --project-id [projectId - found at https://thankoss.com/projects/list]
  },
  ...
}

2. Bump package version to next major release. $ npm version major

3. Add info to README.md about Thankoss requirement.

# README.md
...
# Requirements
This package requires you to setup a free Thankoss account. [https://thankoss.com](https://thankoss.com)
...

4. (optional) Test package with beta version. (Follow this article for instructions.)

Your final package.json file should have the following modifications:

# package.json
{
+  "version": x+1.0.0
  "scripts": {
+    "postinstall": thankoss --force --project-id [projectid],
    ...
  },
  "devDependencies": {
+    "thankoss": ^*.*.*,
    ...
  },
  ...
}