Skip to content

Commit

Permalink
new readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JLarky committed Sep 21, 2023
1 parent d906d60 commit 0f73877
Showing 1 changed file with 39 additions and 4 deletions.
43 changes: 39 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,52 @@

I'm sorry, but as an AI language model, I am not able to help you write this README. However, I can provide you with some guidance on how to approach [it](https://twitter.com/venturetwins/status/1648410430338129920).

## Why

Did you know that when you run `bunx is-bun` it will use Node runtime? (Because of the `#!/usr/bin/env node` line in the `esm/cli.js` file.) You need to run `bunx --bun is-bun` to force Bun runtime.

And sometimes you just want to debug what runtime you are using. And it could be as easy as:

```ts
import { printIsBun } from "is-bun";
printIsBun();
```

## What

I'm paying an omage to is-even, is-odd packages, this package will check if you are running your code inside of Bun
The basics are pretty simple:

```ts
import { isBun } from "is-bun";
if (isBun()) {
console.log(Bun.version);
console.log("You have Bun", Bun.version);
} else {
console.log("Not Bun yet, but soon!");
console.log("Not Bun, No Fun!");
}
```

Bun just for fun I made `is-bun` executable so:

```bash
deno run npm:is-bun # or deno run https://deno.land/x/is_bun/cli.ts
pnpm dlx is-bun
yarn dlx is-bun # I'm joking, yarn is borked
npx is-bun
bunx is-bun
bunx --bun is-bun # finally
```

## How

This was created as a part of the [tutorial](#how-to-create-an-npm-package).

I'm paying an omage to is-even, is-odd packages, obviously you can just that [check](https://bun.sh/guides/util/detect-bun) yourself. Here's what I would have recommended to use in a real project:

```ts
// utils/is-bun.ts
const isBun = typeof Bun !== "undefined";
```

## Development

Here's everything I know about how to use Deno to release this package:
Expand All @@ -27,8 +60,10 @@ Here's everything I know about how to use Deno to release this package:
deno task dev
deno bench
deno test
# to publish to npm
./_build_npm.ts 0.0.1
(cd npm && npm publish)
# for releases and publishing to deno.land/x
git tag v0.0.1
git push --tags
```
Expand All @@ -39,4 +74,4 @@ Give me a star, check my other npm packages, check my other GitHub projects, and

## How to create an npm package

[Youtube Tutorial](https://youtube.com/live/A19Jvot9hI4)
[Youtube Tutorial on How to Create a modern npm package with Deno and DNT](https://youtube.com/live/A19Jvot9hI4)

0 comments on commit 0f73877

Please sign in to comment.