Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add official website and home page #37

Merged
merged 3 commits into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 3 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

[![Build](https://github.com/ipetinate/clingon/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/ipetinate/clingon/actions/workflows/node.js.yml)
[![Release](https://github.com/ipetinate/clingon/actions/workflows/release.yml/badge.svg)](https://github.com/ipetinate/clingon/actions/workflows/release.yml)
[![GitHub Release](https://img.shields.io/github/v/release/ipetinate/clingon?display_name=release&logo=github&label=Release%20version)](https://github.com/ipetinate/clingon/releases)
[![NPM Version](https://img.shields.io/npm/v/clingon?logo=npm&label=NPM%20version)](https://www.npmjs.com/package/clingon)
[![GitHub Release Date](https://img.shields.io/github/release-date/ipetinate/clingon?display_date=published_at&logo=npm&label=Release%20Date&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fclingon)](https://www.npmjs.com/package/clingon)
[![Coverage Status](https://img.shields.io/coverallsCoverage/github/ipetinate/clingon?branch=main&logo=coveralls&label=Coverage)](https://coveralls.io/repos/github/ipetinate/clingon/badge.svg?branch=main)
[![GitHub top language](https://img.shields.io/github/languages/top/ipetinate/clingon?logo=javascript&label=Main%20Language%3A%20JS)](https://github.com/ipetinate/clingon)
Expand All @@ -24,6 +26,7 @@ Let's simplify all of this, execute a command, answer some questions, or select

## Links

- Official website: [clingon.dev](https://clingon.dev)
- Releases
- [CHANGELOG](https://github.com/ipetinate/clingon/blob/main/CHANGELOG.md)
- Documentation
Expand Down Expand Up @@ -75,56 +78,3 @@ Note: Maybe on macOS you do not have permission to run the tool if you install i
```shell
clingon gen
```

## Features

> This project is in beta stage (under development), so many of the expected features have not yet been implemented, if you want to contribute, check out the [Contribution Guide](https://github.com/ipetinate/clingon/blob/main/doc/CONTRIBUTION_GUIDE.md)

- [ ] Opinionated resource generation
- [ ] Options
- [x] TypeScript
- [x] Unit Test
- [x] Postfix
- [x] .spec
- [x] .test
- [x] Testing Library
- [x] Test Framework
- [x] Jest
- [x] Vitest
- [ ] Storybook Story
- [ ] CSS Style
- [x] Vanilla CSS
- [x] CSS Modules
- [x] SASS/SCSS
- [x] TailwindCSS w/ @apply
- [x] TailwindCSS inline (inside `class` attr)
- [ ] CSS-in-js
- [ ] Frameworks
- [ ] Vue
- [ ] Version
- [x] 2
- [ ] 3
- [x] Composition API
- [ ] Options API
- [x] Page
- [x] Component
- [ ] Mixin
- [ ] Filter
- [ ] Hook
- [x] React
- [x] Component
- [x] Page
- [ ] Hook
- [ ] Other resources
- [x] Function
- [ ] Model
- [ ] Enum
- [ ] Type
- [ ] Class
- [ ] Story
- [ ] Unit Test (.spec|.test)
- [ ] Advanced resource generation
- [ ] Local custom templates
- [ ] Configuration file-based generation
- [ ] Generation based on existing files
- [ ] Composite dynamic generation (using several code snippets)
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"main": "./lib/main.js",
"bin": "./lib/main.js",
"author": "Isac Petinate <idpetinate@gmail.com>",
"homepage": "https://clingon.dev",
"repository": {
"url": "https://github.com/ipetinate/clingon",
"type": "public"
Expand Down
Loading