For all the popular Reference Manager formats\r\n \r\n
\r\n\r\n## 📝 Table of Contents\r\n\r\n- [Quick Start](#quick)\r\n- [Getting Started](#getting_started)\r\n- [Deployment](#deployment)\r\n- [Usage](#usage)\r\n- [Built Using](#built_using)\r\n- [Todo](TODO.md)\r\n- [Contributing](CONTRIBUTING.md)\r\n- [Authors](#authors)\r\n- [Acknowledgments](#acknowledgement)\r\n\r\n## ⌛️ Quick Start \r\n\r\nSee it on [npm](https://www.npmjs.com/package/@afnan.bashir/dxipher-js)\r\n\r\n```\r\nnpm i @afnan.bashir/dxipher-js\r\n```\r\n\r\nUse like below\r\n\r\n```js\r\nconst { bibtexToJSON } = require(\"@afnan.bashir/dxipher-js\");\r\n\r\n//Read your .bib and pass the content\r\nbibtexToJSON(content);\r\n```\r\n\r\nSee the documentation [here](https://devisle.netlify.com/)\r\n\r\n## 🧐 About \r\n\r\nReference JS is a collection of parsing functions for Node that allow you to import, export and convert between BibTeX, EndNote, XML, JSON files and more.\r\n\r\nReference Managers are software tools used to organise research work. We aim to tackle the vast Reference Manager format types that exist i.e. bibtex, f1000, XML.\r\n\r\nBy parsing all formats into JSON, we alleviate the need to for JSON based storage and point-to-point conversion i.e. Bibtex to JSON to XML.\r\n\r\nThe project was forked from [devisle](https://github.com/devisle/reference-js) and has been extended to support other file formats.\r\n\r\n## 🏁 Getting Started \r\n\r\nThese instructions will set reference-js up and running on your local machine for development and deployment purposes. See [Usage](#usage) for notes on how to use the API.\r\n\r\n### Prerequisites\r\n\r\nYou will need NodeJS and NPM. Not sure if you have node or npm? use in your terminal:\r\n\r\n```\r\nnode -v\r\n```\r\n\r\n### Installing\r\n\r\nInstall the package with\r\n\r\n```\r\nnpm install @afnan.bashir/dxipher-js\r\n```\r\n\r\n## 🔧 Contributors\r\n\r\nSee the [To do](TODO.md) for required features to work on.\r\n\r\nFurther information on how to contribute [Here](CONTRIBUTING.md).\r\n\r\n## 🎈 Usage \r\n\r\nFormats from Reference managers can be converted into JSON and back. Using this approach, you are able to leverage the library to convert between other formats e.g. Bibtex to JSON to RIS behind the scenes.\r\n\r\n\r\n## 🚀 Deployment \r\n\r\nWe recommend storing your references in JSON format as it is highly compatible with NoSQL databases and Web Applications.\r\n\r\n## ⛏️ Built Using \r\n\r\n- [Chevrotain](https://sap.github.io/chevrotain/docs/) - Parser toolkit\r\n- [regex101](https://regex101.com/) - Regex Tester\r\n- [Jest](https://jestjs.io/) - Testing Framework\r\n- [NodeJs](https://nodejs.org/en/) - Server Environment\r\n\r\n## ✍️ Authors \r\n\r\n- [@afnan](https://github.com/afnan) - Forked and Extension\r\n\r\nOriginal Authors:\r\n\r\n- [@natedeploys](https://github.com/Natedeploys) - Idea & Initial work\r\n- [@endormi](https://github.com/endormi) - Contributor\r\n- [@shreyas1307](https://github.com/shreyas1307) - Contributor\r\n\r\n\r\n## 🎉 Acknowledgements \r\n\r\n- I am grateful to Dev Isle for uploading nicely designed project on which I was able to extend\r\n","readmeFilename":"README.md"}