Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

related #1

Open
3 of 5 tasks
maxkoryukov opened this issue Dec 23, 2016 · 3 comments
Open
3 of 5 tasks

related #1

maxkoryukov opened this issue Dec 23, 2016 · 3 comments

Comments

@maxkoryukov
Copy link
Owner

maxkoryukov commented Dec 23, 2016

This is a part of arjunkomath#9

Solution for API v2

If you are not going to maintain project in the future:

  1. merge PR (I will send it) with deprecation warning
  2. publish new version on NPM (with deprecation warning in the description)
  3. mark the package as deprecated to warn existing users:
npm deprecate <pkgname> "Deprecated in favor of node-freshdesk-api"

Similar projects

this project, on APIv2: https://www.npmjs.com/package/node-freshdesk-api

v1:

v2:

and there are several packages about freshdesk SDK

@kumarharsh
Copy link

seems like some of them are hardly maintained though

@maxkoryukov
Copy link
Owner Author

Most of repositories have 3-5 commits, and very limited set of implemented functions. Sometimes - without documentation.

@maxkoryukov
Copy link
Owner Author

maxkoryukov commented Jan 4, 2017

WARNING

npm version

This repository and corresponding NPM package are deprecated in favor of freshdesk-api.

Useful links:

  1. NPM package:
    • v2 is preferred: npm install freshdesk-api
    • v1: npm install freshdesk-api@APIv1
  2. GitHub, node-freshdesk-api:

PR

header

Deprecate in favor of freshdesk-api (v2)

body

Hello, I would like to offer you to take part in this open source, github-based freshdesk-project: https://github.com/arjunkomath/node-freshdesk-api . I'm sure, this project could be a good alternative for your project.

So, if you are not going to maintain your project in the future:

  1. Merge this PR to your repository
  2. Publish your old package on NPM (to publish the new README.md on NPM)
    npm publish
  3. Deprecate your old NPM package, with this command:
    npm deprecate <YOUR-PACKAGE-NAME> "Please, use this package: freshdesk-api"
    Like this:
    npm deprecate node-freshdesk-myown "Please, use this package: freshdesk-api"

Don't unpublish your package, it is enough to deprecate it 👍

Checklist

  • merge PR
  • publish on NPM
  • deprecate on NPM

PS: this PR is a part of #1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants