Skip to content

Commit

Permalink
chore: adds nitro-module gif file and modifies docs
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickkabwe committed Dec 1, 2024
1 parent bc66b7c commit 1272085
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 21 deletions.
5 changes: 5 additions & 0 deletions .changeset/tall-cougars-try.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-nitro-module': patch
---

adds nitro-module gif file and modifies docs
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# 🚀 Nitro Module CLI

Create cross-platform native modules with ease!
A CLI tool that simplifies creating React Native modules powered by Nitro Modules.

[![Version](https://img.shields.io/npm/v/create-nitro-module.svg)](https://www.npmjs.com/package/create-nitro-module)
[![Downloads](https://img.shields.io/npm/dm/create-nitro-module.svg)](https://www.npmjs.com/package/create-nitro-module)
[![License](https://img.shields.io/npm/l/create-nitro-module.svg)](LICENSE)

![CLI Demo](./assets/nitro-module-cli.gif)

## 📦 Quick Start

Expand All @@ -26,7 +32,7 @@ nitro-module
```bash
Usage: nitro-module [options] [command]

CLI that enables you to create react native modules with Nitro Modules
A CLI tool that simplifies creating React Native modules powered by Nitro Modules.

Options:
-v, --version output the version number
Expand All @@ -44,22 +50,8 @@ Commands:
bun create nitro-module my-awesome-module
```

## 🔧 Supported Features

### Platforms

- 📱 iOS
- 🤖 Android

### Languages

- 🔵 Swift (iOS)
- ☕️ Kotlin (Android)
- 🔧 C++ (Both)

### Package Managers
## What's Inside?

- 🥟 bun (default)
- 🧶 yarn
- 📦 pnpm
- 🎁 npm
- 📱 Pre-configured iOS & Android native module templates
- 📦 Automatic linking and installation
- 📚 TypeScript support out of the box
Binary file added assets/nitro-module-cli.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "create-nitro-module",
"version": "0.18.2",
"description": "CLI that enables you to create react native modules with Nitro Modules",
"description": "A CLI tool that simplifies creating React Native modules powered by Nitro Modules.",
"private": false,
"type": "module",
"files": [
Expand Down

0 comments on commit 1272085

Please sign in to comment.