meetfy 1.0.0 → 1.0.2

package/README.md

@@ -1,158 +1,43 @@
-# Meetfy CLI
+<div align="center">
+  <h1>📆 meetfy</h1>
+  <h4>A CLI tool for creating instant meetings and reserving time in Google Calendar.</h4>
 
-A command-line tool for creating instant meetings and reserving 30 minutes in Google Calendar.
+  ![npm](https://img.shields.io/npm/v/meetfy) ![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/meetfy?color=green-light) ![npm](https://img.shields.io/npm/dw/meetfy)
 
-## Features
-
-- 🚀 Create instant meetings with Google Meet
-- 📅 Automatically reserve 30 minutes in your Google Calendar
-- 👥 Add participants via email
-- 🔐 Secure Google OAuth2 authentication
-- 💾 Persistent authentication tokens
-- 🎨 Beautiful CLI interface with colors and spinners
-
-## Installation
-
-1. Clone the repository:
-```bash
-git clone <repository-url>
-cd meetfy
-```
-
-2. Install dependencies:
-```bash
-npm install
-```
-
-3. Build the project:
-```bash
-npm run build
-```
+</div>
 
-4. Link globally (optional):
-```bash
-npm link
-```
-
-## Setup
-
-### 1. Google Calendar API Setup
-
-1. Go to [Google Cloud Console](https://console.cloud.google.com)
-2. Create a new project or select an existing one
-3. Enable the Google Calendar API:
-   - Go to "APIs & Services" → "Library"
-   - Search for "Google Calendar API"
-   - Click "Enable"
-4. Create OAuth 2.0 credentials:
-   - Go to "APIs & Services" → "Credentials"
-   - Click "Create Credentials" → "OAuth 2.0 Client IDs"
-   - Choose "Desktop application"
-   - Download the credentials file
-5. Rename the downloaded file to `credentials.json` and place it in the project root
-
-The `credentials.json` file should look like this:
-```json
-{
-  "installed": {
-    "client_id": "your-client-id.apps.googleusercontent.com",
-    "project_id": "your-project-id",
-    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-    "token_uri": "https://oauth2.googleapis.com/token",
-    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-    "client_secret": "your-client-secret",
-    "redirect_uris": ["http://localhost"]
-  }
-}
-```
-
-### 2. Authentication
-
-Run the authentication command:
-```bash
-npm run dev auth
-# or if linked globally:
-meetfy auth
-```
 
-Follow the authentication flow to authorize the application.
-
-## Usage
+## Features
+- 🎯 Create instant meetings and reserve time in Google Calendar.
+- 📝 Add participants to the meeting.
+- 🕒 Choose the duration of the meeting.
 
-### Create an Instant Meeting
 
-Basic usage:
-```bash
-npm run dev create
-# or if linked globally:
-meetfy create
-```
+## Install
 
-With options:
-```bash
-meetfy create -t "Team Standup" -d "Daily team sync" -p "john@example.com,jane@example.com"
+```sh
+npm i -g meetfy
 ```
 
-### Available Options
-
-- `-t, --title <title>`: Meeting title
-- `-d, --description <description>`: Meeting description
-- `-p, --participants <emails>`: Comma-separated list of participant emails
-
-### Authentication
+## Quickstart
 
-To authenticate or re-authenticate:
-```bash
-meetfy auth
+```sh
+npm i -g meetfy
+meetfy auth    # authenticate with Google Calendar
+meetfy create  # create a new meeting
+meetfy next    # show your next meeting
+meetfy logout  # log out
 ```
 
-## Development
+Use `--json` for machine-readable output (e.g. `meetfy --json next`).
 
-### Run in Development Mode
-```bash
-npm run dev
-```
-
-### Build for Production
-```bash
-npm run build
-```
+## Publishing (maintainers)
 
-### Run Built Version
-```bash
-npm start
+```sh
+pnpm run build   # build dist/index.js
+npm publish      # runs prepublishOnly (build) then publishes
 ```
 
-## Project Structure
-
-```
-src/
-├── features/
-│   ├── auth/
-│   │   └── authService.ts      # Google OAuth2 authentication
-│   └── meeting/
-│       └── meetingService.ts   # Meeting creation and calendar integration
-├── utils/
-│   └── cliUtils.ts            # CLI utilities and formatting
-└── index.ts                   # Main CLI entry point
-```
-
-## Features
-
-- **Instant Meeting Creation**: Creates meetings that start in 5 minutes
-- **30-Minute Duration**: Automatically sets 30-minute duration
-- **Google Meet Integration**: Includes Google Meet link in calendar events
-- **Participant Management**: Add participants via email addresses
-- **Calendar Reminders**: Sets up email and popup reminders
-- **Persistent Authentication**: Saves and reuses authentication tokens
-- **Interactive CLI**: User-friendly prompts and colorful output
-
-## Requirements
-
-- Node.js 18+
-- Google Calendar API access
-- Google OAuth2 credentials
-
 ## License
 
-ISC 
+MIT © [@eduardoborges](https://github.com/eduardoborges)