quick-readme v1.1.2
šļø Table of Contents
āļø Features
Feature | Description |
---|---|
Easy Readme Generation | Generate professional README files with a simple command. No need to worry about formatting or layout. |
Fast & Simple | Designed for ease of use. The intuitive interface guides you through the process in a matter of seconds. |
Fully Advanced Results | Offers advanced options for customizing your README, including adding badges, custom scripts, and more. |
š¦ Installation
Global Installation
To install the quick-readme
package globally, open your terminal and run the following command:
npm install -g quick-readme
This will install the package globally, allowing you to use the quick-readme
command anywhere in your terminal.
Local Installation
To install the quick-readme
package locally in your project, navigate to your project's directory and run:
npm install quick-readme --save-dev
This will install the package as a dev dependency in your project.
š Usage
Question Usage
Run the quick-readme
command and answer the questions prompted to generate your README:
quick-readme
Config Usage
You can also generate a README using a configuration file. Create a file named quick-readme.json
in your project root and populate it with your project details. You can check out an example configuration file /example.quick-readme.json or click the summary below to see the contents with details.
{
// The title of your project
"title": "quick-readme",
// A brief description of your project
"description": "A CLI tool to generate README files super fast and easily!",
// The GitHub repository URL of your project
"repo": "https://github.com/BankkRoll/quick-readme",
// The website URL of your project (if available)
"websiteUrl": "",
// The URL for the banner image to display at the top of your README
"bannerUrl": "https://github.com/BankkRoll/quick-readme/assets/106103625/332aaeb9-0df8-439c-bd72-a1777b0e2019",
// Your name or your organization's name
"authorName": "BankkRoll",
// Your GitHub handle
"authorGithub": "BankkRoll",
// Your Twitter handle
"authorTwitter": "bankkroll_eth",
// Features of your project, separated by commas
"projectFeatures": "Easy Readme Generation, Fast & Simple, Fully Advanced Results",
// The npm package name (if your project is an npm package)
"npmPackage": "quick-readme",
// The build tool your project uses
"buildTool": "",
// The license your project is under
"licenseType": "MIT",
// Programming languages used in the project
"languages": ["JavaScript", "TypeScript"],
// Frameworks used in the project
"frameworks": [],
// Scripts you want to highlight in your README
"selectedScripts": [
"start",
"build",
"format",
"add-shebang",
"prepublishOnly"
],
// Badges to display at the top of your README
"selectedBadges": [
"npm version",
"License",
"Languages",
"GitHub Stars",
"GitHub Last Commit",
"GitHub Repo Size"
],
// Internal name of your project (usually the repo name)
"name": "quick-readme",
// Any custom scripts your project uses
"scripts": {
"start": "npm run start",
"build": "npm run build",
"format": "npm run format",
"add-shebang": "npm run add-shebang",
"prepublishOnly": "npm run prepublishOnly"
},
// Information about your project's repository
"repository": {
"url": "https://github.com/BankkRoll/quick-readme.git"
},
// License information
"license": "MIT",
// Author information
"author": "BankkRoll"
}
š ļø Scripts
Here are some common scripts you can run:
start
Starts the application.
You can run this script using npm or yarn:
npm run start
Or with yarn:
yarn start
build
Builds the application for production.
You can run this script using npm or yarn:
npm run build
Or with yarn:
yarn build
š³ Directory Tree
āāā š .npmignore
āāā š .prettierrc
āāā š add-shebang.js
āāā š¦ dist/
āāā š index.d.ts
āāā š index.js
āāā š index.js.map
āāā š utils/
āāā š analyzeCodebase.d.ts
āāā š analyzeCodebase.js
āāā š analyzeCodebase.js.map
āāā š formatScripts.d.ts
āāā š formatScripts.js
āāā š formatScripts.js.map
āāā š generateReadme.d.ts
āāā š generateReadme.js
āāā š generateReadme.js.map
āāā š guessMainLanguage.d.ts
āāā š guessMainLanguage.js
āāā š guessMainLanguage.js.map
āāā š languages.d.ts
āāā š languages.js
āāā š languages.js.map
āāā š tree.d.ts
āāā š tree.js
āāā š tree.js.map
āāā š example.quick-readme.json
āāā š LICENSE.txt
āāā š package-lock.json
āāā š package.json
āāā š¦ src/
āāā š index.ts
āāā š utils/
āāā š analyzeCodebase.ts
āāā š formatScripts.ts
āāā š generateReadme.ts
āāā š guessMainLanguage.ts
āāā š languages.ts
āāā š tree.ts
āāā š README.md
āāā š tsconfig.json
āāā š types.d.ts
š» Language Usage
TypeScript: āāāāāā 58.41%
JSON: āā 22.52%
Markdown: āā 17.65%
Other: 1.43%
š¤ Contributing
- Fork the Project
- Create your Feature Branch
- Commit your Changes
- Push to the Branch
- Open a Pull Request
- Code review
- Merge the changes
- Update the documentation
š License
This project is licensed under MIT.
š¤ Author
- Twitter: @bankkroll_eth
- GitHub: @BankkRoll
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago