diff --git a/README.md b/README.md index ce6c97d..036ae3b 100644 --- a/README.md +++ b/README.md @@ -1,115 +1,96 @@ -
- -

Node Bard | A perfect module to get AI to your projects

- - -
+

+ +

+

Node Bard | AI-Powered Modules for Your Projects

+

Empower your projects with artificial intelligence using Node Bard.

+

+ + Build Status + + + Discord Server + + + npm version + + + npm downloads + +

+ +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [FAQ](#faq) +- [Contributors](#contributors) +- [Bug Hunters](#bug-hunters) +- [Support](#support) +- [Contribution Guidelines](#contribution-guidelines) +## Installation -### Installation +To integrate Node Bard into your project, open your terminal and execute the following command: -Open command prompt and type: -``` shell -npm i @nishantapps/node-bard +```shell +npm install @nishantapps/node-bard ``` -### Usage +## Usage -```js +Utilize the magic of Node Bard by adding the following code to your project: + +```javascript const bard = require('@nishantapps/node-javaris'); const config = { - userid:'', - key:'', - apikey:'' + userid: '', // Obtain your user ID from Discord + key: '', // Acquire from https://makersuite.google.com + apikey: '', // Your RapidAPI key }; bard.setConfig(config); async function main() { - try { - const prompt = 'नमस्ते, मैं निशांत शर्मा हूं'; - - // Translate the prompt to English or any lang. - const translatedText = await bard.translateText(prompt, 'auto', 'en'); - - // Create text using Bard API, Clean version: - const createdText = await bard.createText(translatedText); - - console.log(createdText); - - // try & catch method. - } catch (error) { - console.error(`Error in main function: ${error.message}`); - } + const result = await bard.createText('Your text goes here'); + console.log(result); } main(); ``` -### Faq: +## Frequently Asked Questions ->How to get key? +### How to Get the Key? ---> Go to https://makersuite.google.com and get it from there +Visit [Makersuite](https://makersuite.google.com) and obtain your key. -> Where to get userid? +### Where to Get User ID? ---> Go to our discord server https://discord.gg/Fnt6qDrJGQ and execute the command in #register channel: ``/register``. You will get your userid in your dms +Join our [Discord server](https://discord.gg/Fnt6qDrJGQ) and execute the command `/register` in the #register channel. Your user ID will be sent to your DM. -# Contributers +## Contributors +A big thank you to our amazing contributors: -Thanks goes to these wonderful people ([:hugs:](https://allcontributors.org/docs/en/emoji-key)): +| [![npmnishantsharma](https://avatars.githubusercontent.com/u/99231654?v=4)](https://github.com/npmnishantsharma) | [![Alpha5959](https://avatars.githubusercontent.com/u/109584578?v=4)](https://github.com/Alpha5959) | +|:---:|:---:| +| [**npmnishantsharma**](https://github.com/npmnishantsharma) | [**Alpha5959**](https://github.com/Alpha5959) | - - - - - - - - - - -
- - npmnishantsharma -
- npmnishantsharma -
-
- - npmnishantsharma -
- npmnishantsharma -
-
- -

Bug Hunters

- -Thanks goes to these wonderful people for getting bugs in our app ([:hugs:](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - -
- - npmnishantsharma -
- Dae -
-
- - npmnishantsharma -
- Alpha -
-
+## Bug Hunters + +Big shoutout to these brilliant bug hunters: + +| [![Dae](https://cdn.discordapp.com/avatars/793482727223590922/1505e99841dbffd52ae7eb02450efbc0.webp?size=4096)](https://dsc.gg/nishantapps-community) | [![Alpha](https://cdn.discordapp.com/avatars/783661052738011176/f7a9f1ee9b131406713192235aba4050.webp?size=1024&width=0&height=320)](https://dsc.gg/nishantapps-community) | +|:---:|:---:| +| [**Dae**](https://dsc.gg/nishantapps-community) | [**Alpha**](https://dsc.gg/nishantapps-community) | + +## Support + +For any queries or assistance, feel free to join our [Discord server](https://discord.gg/Fnt6qDrJGQ). + +## Contribution Guidelines + +Interested in contributing? Just fork this project and request a pull. + +).