0nom4d / mdcreator Goto Github PK
View Code? Open in Web Editor NEWmdCreator creates a README.md file from command line and with a .json configuration file.
License: MIT License
mdCreator creates a README.md file from command line and with a .json configuration file.
License: MIT License
This feature will be included because of the creation of a roadmap for the mdCreator.
That's just a CHANGELOG.md file adding. Keep calm...
Nothing incredible here.
##When will it be up?
This feature will be added to repository in the next update.
Hi, here's 0Nom4D,
You can find below an error that can occur when using mdCreator:
This error will be fixed as soon as possible.
A bug appears when no gif keywords are given as arguments. It will search gifs with the languages name.
To Reproduce
Steps to reproduce the behavior:
$> mdCreator -p $(project_name) -l $(language)
Expected behavior
Without any gif keywords, no gifs should be added inside the REAMDE.md file.
mdCreator is getting a makeover. In the next weeks, I will try to rework the project a bit.
mdCreator is a basic project. To be realistic, the project in this state is kinda useless... Why loosing time writing a JSON file while you can in the same amount of time, write the README entirely?
That is a big loss of time. So what can we do to improve our functionalities? What project we can inspire from in order to improve our project?
In the next release, mdCreator will have two ways to work:
The project will still work with your custom configuration and the pro / student configurations. Don't worry it will still be working!
Based on NPX way to work, a '--template' option will be added to the project. This option will get a README template you will choose. Then the project will create the README file and fill it with the template you chose.
This feature would increase the usability of the project and will avoid you useless jobs.
As you know, mdCreator allows users to call for the Tenor API to get Gifs Images.
The number of Gifs included in the created file is 2.
The next step is to allow users to ask for more Gifs by adding an option to the configuration file.
You could tho ask x Gifs for every README file you create, accordingly to the value in the configuration file.
This feature will be available in the next update of mdCreator.
By using the mdCreator, you would ask for cooler and cooler features.
For now on, mdCreator Team (that means me but that seems cool to write this) will develop an auto-updater file.
Such as OhMyZsh, when you'll launch the mdCreator, the mdCreator will:
This will allow you to always be connected to the project even without thinking about it.
This feature will be available on an unknown date. Keep checking this issue for more informations.
Update the "Prerequisites" section with the language enter with the -l option, it would very convenient and more easy to use for lazy people like me
At commit 5f5920f, I tried to add a .env file to camouflage my API Key. Unfortunately, I was a fool and I didn't thought I would have to commit my .env file without document it.
At first, I wanted not to let users have their own API Key and to have a fully useful program ready to use.
I let security breaches open and nobody forced it. Unfortunately, I need to secure these breaches because 2 reasons:
From now on, mdCreator will ask for your Tenor API Key at first launch.
It will take your API key to work. A wiki page will be opened and a link in the project README will be added to this wiki page.
This feature is designed for non-student users. The goal is to have the best configuration experience for mdCreator.
When launching the program after the update, the program will ask you if you're a student or not.
If you are a student, the program will write the result as it writes now.
If you're not, the program will write the file without concerning any organization.
If you work for an organization and you want to mention it, you'll be able to.
This feature will be updated in the next mdCreator release.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.