Skip to content

Commit

Permalink
Update base version to 0.0.5, copy the README to packages/wrangler (#152
Browse files Browse the repository at this point in the history
)
  • Loading branch information
threepointone authored Dec 21, 2021
1 parent 096197d commit 421f2e4
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .changeset/tasty-vans-reflect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"wrangler": patch
---

Update base version to 0.0.5, copy the README to packages/wrangler
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
id: changesets
uses: changesets/action@v1
with:
publish: cp README.md packages/wrangler/README.md && npx changeset publish --tag beta
publish: npx changeset publish --tag beta
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_PUBLISH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/wrangler/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# wrangler

## 0.0.1
## 0.0.5

### Patch Changes

Expand Down
51 changes: 51 additions & 0 deletions packages/wrangler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## 🤠 wrangler

`wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).

[(Read the full stack week launch blog post.)](https://blog.cloudflare.com/wrangler-v2-beta/)

**DISCLAIMER**: This is a work in progress, and is NOT recommended for use in production. We are opening this preview for feedback from the community, and to openly share our [roadmap](https://github.com/cloudflare/wrangler2/issues/12) for the future. As such, expect APIs and documentation to change before the end of the preview.

Further, we will NOT do a general release until we are both feature complete, and have a full backward compatibility and incremental migration plan in place. For more details, follow the [parent roadmap issue](https://github.com/cloudflare/wrangler2/issues/12).

## Quick Start

```bash
# Make a javascript file
$ echo "export default { fetch() { return new Response('hello world') } }" > index.js
# try it out
$ npx wrangler@beta dev index.js
# and then publish it
$ npx wrangler@beta publish index.js --name my-worker
# visit https://my-worker.<your workers subdomain>.workers.dev
```

## Installation:

```bash
$ npm install wrangler@beta
```

## Commands

### `wrangler init [name]`

Creates a `wrangler.toml` configuration file. For more details on the configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).

### `wrangler dev [script]`

Start a local development server, with live reloading and devtools.

### `wrangler publish [script] --name [name]`

Publish the given script to the worldwide Cloudflare network.

For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).

### `wrangler pages dev [directory] [-- command]`

Either serves a static build asset directory, or proxies itself in front of a command.

Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory.

For more commands and options, refer to the [documentation](https://developers.cloudflare.com/pages/platform/functions#develop-and-preview-locally) or run `wrangler pages dev --help`.
2 changes: 1 addition & 1 deletion packages/wrangler/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "wrangler",
"version": "0.0.1",
"version": "0.0.5",
"author": "[email protected]",
"description": "Command-line interface for all things Cloudflare Workers",
"bin": {
Expand Down

0 comments on commit 421f2e4

Please sign in to comment.