1.0.0 • Published 1 year ago

gondor_data v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

Contributors Forks Stargazers Issues MIT License

About The Project

Product Name Screen Shot

There are many sets of data available on GitHub/API; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a sets of data so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like fetching again and again data.

Of course, no one set of data will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by opening issues. Thanks to all the people have contributed to expanding this template !

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

Install NPM packages

npm install gondor_data

Usage

For more examples, please refer to the Documentation

Roadmap

  • see the wiki lists
  • Publish
  • Add Additional set of data
  • Manage to download section data like /science, /medecine, /geo, /anthropos no idea how manage this
  • Multi-language Support
    • English
    • French
    • Deutch
    • Chinese
    • Italian
    • Others

See the open issues for a full list of proposed features (and known issues).

Contributing

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!

  1. Open Issue for exchange of ideas
  2. Fork the Project
  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!