Skip to content

Commit

Permalink
fix: readme with details
Browse files Browse the repository at this point in the history
  • Loading branch information
Avivbens committed Jun 6, 2024
1 parent c67ec16 commit 18f8e90
Showing 1 changed file with 42 additions and 6 deletions.
48 changes: 42 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,46 @@
<div align="center">

# Build Amazing Alfred Workflows! :ninja:

### `fast-alfred` - Your Alfred friendly framework, for developing Alfred workflows in TypeScript/JavaScript.
**`fast-alfred` - Your Alfred friendly framework**, for developing Alfred workflows in TypeScript/JavaScript.

**Turn your new Mac into a useful working station in minutes**

<br>

[![npm](https://img.shields.io/npm/v/fast-alfred)](https://www.npmjs.com/package/fast-alfred)
[![npm](https://img.shields.io/npm/dt/fast-alfred)](https://www.npmjs.com/package/fast-alfred)
![GitHub](https://img.shields.io/github/license/avivbens/fast-alfred)

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/kcao7snkgx)

### <a href="https://avivbens.github.io/fast-alfred/" target="_blank">Read Our Official Docs 📚</a>

</div>

## Installation

```bash
npm install fast-alfred
```

# The Reason

`fast-alfred` lets you think about the functionality, rather than the boilerplate.

It provides you with a convenient way to manage your workflow, apply proper versioning, and bundle it into a `.alfredworkflow` file.

## The Hard Time When Developing Alfred Workflows In Node.js

According to [Alfred's official community](https://www.alfredforum.com/topic/21366-nodejs-workflows-deployment/?do=findComment&comment=110924),
it is not a best-practice to include any external dependencies at installation time,
so all of your code and its dependencies should be included in the workflow file.

[Alfred Gallery](https://alfred.app/) requires you to upload a `.alfredworkflow` file, which is a zip archive containing all the necessary files for your workflow to run.

In order to accomplish this task, we need to bundle our code into a single file and include it in the workflow.

## Features
## The Solution

- **TypeScript/JavaScript** - Write your workflows in TypeScript or JavaScript, including external libraries.
- **Alfred Friendly** - Automatically generate Alfred friendly JSON output.
- **Workflow Management** - Automatically generate Alfred workflow metadata.
- **Bundle Management** - Automatically bundle your workflow into a `.alfredworkflow` file.
`fast-alfred` allows you to bundle your production code into a few scripts, and include them in the workflow.
All bundle options are configurable, via a `.fast-alfred.config.cjs` file at the root of your project.

0 comments on commit 18f8e90

Please sign in to comment.