jng
v1.0.6
Published
Converts .jpg urls to .png urls and vice versa.
Downloads
1
Readme
About The Project
Converts .jpg urls to .png urls and vice versa.
- How it works Images are sent to a cloudinary server and then converted to .png or .jpg. The package willthen return the changed url.
Getting Started
- Make a account on cloudinary - https://cloudinary.com/users/register/free
- Copy the cloud name, api key and api secret from the cloudinary console - https://cloudinary.com/console
- Paste the cloud name, api key and api secret in the .env file named
CLOUD_NAME
,API_KEY
andAPI_SECRET
- Check env_example file for more info - env_example
- Install the required packages -
cloudinary, dotenv, fs
- Install jng using npm
npm install jng
- Require the package in your main file
const jng = require('jng');
Functions
jng.init({
cloud_name: process.env.CLOUD_NAME,
api_key: process.env.API_KEY,
api_secret: process.env.API_SECRET
});
// Init function is used to setup the cloudinary server
jng.upload('tests/test.json', 'kurizu', 'png', 'anime').then(url => {
console.log(url);
});
Note
- Here tests/test.json - is the path to the image you want to send and it looks like this -
[
"https://kurizuanime_1.jpg",
"https://kurizuanime_2.jpg"
]
- kurizu - is the name that i want to add to the url
- png - is the format that i want to convert the image to
- anime - is the tag that i want to add to the image
// Upload function uploads the image to the channel and then fetches its url Check env_example file for more info - env_example
Usage
const jng = require('jng');
require('dotenv').config()
jng.init({
cloud_name: process.env.CLOUD_NAME,
api_key: process.env.API_KEY,
api_secret: process.env.API_SECRET
});
jng.upload('tests/test.json', 'kurizu', 'png', 'anime').then(url => {
console.log(url);
});
For more information on how to use it visit
Roadmap
- [ ] Add Changelog
- [ ] Add Tests
- [ ] Add Additional Templates w/ Examples
- [ ] Add Support for more image formats
- [ ] Documentation
- [ ] Website
- [ ] Examples
- [ ] Wiki
- [ ] Add Support for more platforms
See the open issues for a full list of proposed features (and known issues).
Contributions
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
Package Made by: kurizu.taz
on discord
Github - https://github.com/crizmo/JNG