Merge pull request #1 from raisiqueira/chore/project-setup

chore: base project

Author: raisiqueira

.github/workflows/size.yml

@@ -20,4 +20,5 @@ jobs:
       - uses: andresz1/size-limit-action@v1
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          build_script: "build"
+          build_script: 'build'
+          platform: 'node'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Raí Siqueira
+Copyright (c) 2023 Raí Siqueira
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,18 @@
-# pnpm-monorepo
+# create-eruption 🌋
 
-> A PNPM monorepo template to my personal projects.
+> The official template to create a new Eruption project.
 
-## What is in this repository?
+## Usage
+
+To initialize a new project, run the following command:
+
+```bash
+npm init eruption@latest
+```
+
+### Contributing to this CLI
+
+### What is in this repository?
 
 - [PNPM](https://pnpm.io/workspaces) as workspace manager and package manager.
 - [TSUP](https://tsup.egoist.dev/) as a TypeScript universal package.
@@ -12,25 +22,10 @@
 - [ESLint](https://eslint.org/) as a code linter.
 - [Turbo](https://turbo.build) as cacheable build tool.
 
-## Using this repository
-
-- clone the repository or click in "Use this template" button.
-- Go to `lib/package.json` and edit the `name`, `description` and `author` fields.
-
-## Folder structure
+### Folder structure
 
 - docs - An empty folder to store documentation.
-- example - A folder with an example project. Think as playground.
-- lib - A folder with a library.
-
-## Using Turbo to run commands
-
-Turbo is a cacheable build tool. This project uses it to run the `build`, `test` and `coverage` commands.
-
-```bash
-# Instead of running `pnpm build`, run:
-pnpx turbo build
-```
+- lib - The CLI source.
 
 ## License