Merge branch 'release/1.0.0-alpha.1'

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.0-alpha.1] - 2024-01-31
+
+### Documentation
+
+- Update the readme file of the project
+- Add a new contributing guideline for the project
+
 ## [1.0.0-alpha.0] - 2024-01-31
 
 ### Features

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# How to Contribute
+
+## Pull Requests
+
+1. Fork the repository
+2. Create a new branch for each feature or improvement
+3. Send a pull request from each branch to the **develop** branch
+
+It is very important to separate new features or improvements into separate branches and to send a
+pull request for each branch. This allows reviewing and pulling in new features or improvements individually.

README.md

@@ -6,12 +6,35 @@
 [![Farcaster (Warpcast) Follow](https://img.shields.io/badge/follow-%40nekofar-855DCD.svg?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMzIzIiBoZWlnaHQ9IjI5NyIgdmlld0JveD0iMCAwIDMyMyAyOTciIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxwYXRoIGQ9Ik01NS41ODY3IDAuNzMzMzM3SDI2My40MTNWMjk2LjI2N0gyMzIuOTA3VjE2MC44OTNIMjMyLjYwN0MyMjkuMjM2IDEyMy40NzkgMTk3Ljc5MiA5NC4xNiAxNTkuNSA5NC4xNkMxMjEuMjA4IDk0LjE2IDg5Ljc2NDIgMTIzLjQ3OSA4Ni4zOTI2IDE2MC44OTNIODYuMDkzM1YyOTYuMjY3SDU1LjU4NjdWMC43MzMzMzdaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBkPSJNMC4yOTMzMzUgNDIuNjhMMTIuNjg2NyA4NC42MjY3SDIzLjE3MzNWMjU0LjMyQzE3LjkwODIgMjU0LjMyIDEzLjY0IDI1OC41ODggMTMuNjQgMjYzLjg1M1YyNzUuMjkzSDExLjczMzNDNi40NjgyMiAyNzUuMjkzIDIuMiAyNzkuNTYyIDIuMiAyODQuODI3VjI5Ni4yNjdIMTA4Ljk3M1YyODQuODI3QzEwOC45NzMgMjc5LjU2MiAxMDQuNzA1IDI3NS4yOTMgOTkuNDQgMjc1LjI5M0g5Ny41MzMzVjI2My44NTNDOTcuNTMzMyAyNTguNTg4IDkzLjI2NTEgMjU0LjMyIDg4IDI1NC4zMkg3Ni41NlY0Mi42OEgwLjI5MzMzNVoiIGZpbGw9IndoaXRlIi8+CjxwYXRoIGQ9Ik0yMzQuODEzIDI1NC4zMkMyMjkuNTQ4IDI1NC4zMiAyMjUuMjggMjU4LjU4OCAyMjUuMjggMjYzLjg1M1YyNzUuMjkzSDIyMy4zNzNDMjE4LjEwOCAyNzUuMjkzIDIxMy44NCAyNzkuNTYyIDIxMy44NCAyODQuODI3VjI5Ni4yNjdIMzIwLjYxM1YyODQuODI3QzMyMC42MTMgMjc5LjU2MiAzMTYuMzQ1IDI3NS4yOTMgMzExLjA4IDI3NS4yOTNIMzA5LjE3M1YyNjMuODUzQzMwOS4xNzMgMjU4LjU4OCAzMDQuOTA1IDI1NC4zMiAyOTkuNjQgMjU0LjMyVjg0LjYyNjdIMzEwLjEyN0wzMjIuNTIgNDIuNjhIMjQ2LjI1M1YyNTQuMzJIMjM0LjgxM1oiIGZpbGw9IndoaXRlIi8+Cjwvc3ZnPgo=&style=flat)](https://warpcast.com/nekofar)
 [![Donate](https://img.shields.io/badge/donate-nekofar.crypto-a2b9bc?logo=ko-fi&logoColor=white)](https://ud.me/nekofar.crypto)
 
+Farcaster Frames Template is an easy-to-use template designed for beginners and experienced developers alike. It provides a robust starting point for building Farcaster frames, streamlining the development process. This template is ideal for those looking to create custom frames quickly and efficiently.
 
-```
-pnpm install
-pnpm run dev
-```
+## Getting Started
 
-```
-open http://localhost:3000
-```
+### Prerequisites
+
+- Node.js (Version 18 or later)
+- A text editor like VSCode
+- Basic understanding of TypeScript and Node.js
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/nekofar/farcaster-frames-template.git
+   ```
+2. Navigate to the project directory:
+   ```bash
+   cd farcaster-frames-template
+   ```
+3. Install the dependencies:
+   ```bash
+   pnpm install
+   ```
+4. Start the development server:
+   ```bash
+   pnpm run dev
+   ```
+
+## Contributing
+
+Contributions are what make the open source community such a fantastic place to learn, inspire, and create. Any contributions you make are **greatly appreciated**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "farcaster-frames-template",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.1",
   "keywords": [
     "farcaster",
     "frames",
@@ -30,6 +30,6 @@
     "prettier-plugin-jsdoc": "1.3.0",
     "prettier-plugin-organize-attributes": "1.0.0",
     "prettier-plugin-organize-imports": "3.2.4",
-    "tsx": "3.12.2"
+    "tsx": "4.7.0"
   }
 }