Skip to content

Commit

Permalink
docs: update readme file to add usage and improve wrapping
Browse files Browse the repository at this point in the history
  • Loading branch information
nekofar committed Jan 31, 2024
1 parent e551e52 commit 002e385
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
[![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.
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.

## Getting Started

Expand All @@ -16,7 +18,7 @@ Farcaster Frames Template is an easy-to-use template designed for beginners and
- A text editor like VSCode
- Basic understanding of TypeScript and Node.js

### Installation
### Install

1. Clone the repository:
```bash
Expand All @@ -35,6 +37,15 @@ Farcaster Frames Template is an easy-to-use template designed for beginners and
pnpm run dev
```

### Usage

The template uses [Localtunnel](https://github.com/localtunnel/localtunnel) which allows you to easily test your frames
without the need to deploy them. Everytime running your project, you will receive a random URL, for
example `https://thirty-glasses-tell.loca.lt`. You can directly copy this URL and test your frame using
the [Warpcast Embed Tools](https://warpcast.com/~/developers/embeds). This makes the
development and testing process much more efficient and straightforward.

## 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**
Contributions are what make the open source community such a fantastic place to learn, inspire, and create. Any
contributions you make are **greatly appreciated**

0 comments on commit 002e385

Please sign in to comment.