1.1.1 ā¢ Published 3 years ago
create-foss-files v1.1.1
- Simple: Extremely simple to use.
- Cross-platform: Works on macOS, linux, and Windows.
- JavaScript files: Generates additional files if you are developing a JavaScript project.
- Prettier: Integrated prettier if the project is a JavaScript project.
- MIT Licensed: Free to use for personal and commercial use.
š¦ Installation
# install the CLI globally
npm install -g create-foss-files
# use it with npx (recommended)
npx create-foss-files --flag
š Usage
Create a new project folder. Navigate into it. Run any of the following command inside of it.
# if installed globally (only generates required files)
cff
# if installed globally (add JavaScript files)
cff --javascript
# with npx (only generates required files)
npx create-foss-files
# with npx (add JavaScript files)
npx create-foss-files --javascript
š Directory Structure
Directory tree with cff
āāā [project name]
āāā .editorconfig
āāā .gitattributes
āāā .gitignore
āāā changelog.md
āāā code-of-conduct.md
āāā contributing.md
āāā license
āāā readme
Directory tree with cff --javascript
āāā [project name]
āāā .editorconfig
āāā .gitattributes
āāā .gitignore
āāā .npmrc
āāā .prettierrc.json
āāā changelog.md
āāā code-of-conduct.md
āāā contributing.md
āāā index.js
āāā license
āāā package.json
āāā readme
šØš»āš» Contributing
Make sure you read the contributing guidelines before opening a PR.
š License & Conduct
- MIT Ā© Saad Irfan
- Code of Conduct