Skip to content

Commit 50edc96

Browse files
committed
readme: make it better
1 parent 1d75f6a commit 50edc96

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,41 +30,42 @@ import {signal, effect} from "@e280/strata"
3030
```
3131

3232
### 🚦 each signal holds a value
33-
- **create a signal**
33+
- **make signal**
3434
```ts
3535
const $count = signal(0)
3636
```
37-
- maybe you like the `$` prefix convention for signals
38-
- **read a signal**
37+
> *maybe you like the `$` prefix convention for signals?*
38+
- **read signal**
3939
```ts
4040
$count() // 0
4141
```
42-
- **set a signal**
42+
- **write signal**
4343
```ts
4444
$count(1)
4545
```
46-
- **set a signal, and await all downstream effects**
46+
- **write signal *(and await all downstream effects)***
4747
```ts
4848
await $count(2)
4949
```
50+
> *this is supposed to impress you*
5051
5152
### 🚦 pick your poison
52-
- **signal hipster syntax**
53+
- **signal hipster-fn syntax**
5354
```ts
54-
$count() // get
55-
await $count(2) // set
55+
$count() // read
56+
await $count(2) // write
5657
```
5758
- **signal get/set syntax**
5859
```ts
59-
$count.get() // get
60-
await $count.set(2) // set
60+
$count.get() // read
61+
await $count.set(2) // write
6162
```
6263
- **signal .value accessor syntax**
6364
```ts
64-
$count.value // get
65-
$count.value = 2 // set
65+
$count.value // read
66+
$count.value = 2 // write
6667
```
67-
value pattern is nice for these vibes
68+
value pattern is super nice for these vibes
6869
```ts
6970
$count.value++
7071
$count.value += 1
@@ -84,7 +85,7 @@ import {signal, effect} from "@e280/strata"
8485

8586
### 🚦 `signal.derived` and `signal.lazy` are computed signals
8687
- **signal.derived**
87-
is for combining signals
88+
is for combining signals, like a formula
8889
```ts
8990
const $a = signal(1)
9091
const $b = signal(10)
@@ -101,11 +102,11 @@ import {signal, effect} from "@e280/strata"
101102
- **signal.lazy**
102103
is for making special optimizations.
103104
it's like derived, except it cannot trigger effects,
104-
because it's so lazy it only computes the value on read, and only when necessary.
105+
because it's so damned lazy, it only computes the value on read, and only when necessary.
105106
> *i repeat: lazy signals cannot trigger effects!*
106107
107108
### 🚦 core primitive classes
108-
- **the hipster syntax has a slight performance cost**
109+
- **the hipster-fn syntax has a slight performance cost**
109110
- **you can instead use the core primitive classes**
110111
```ts
111112
const $count = new Signal(1)
@@ -143,7 +144,7 @@ import {signal, effect} from "@e280/strata"
143144
- **`Signaly<V>`**can be `Signal<V>` or `Derived<V>` or `Lazy<V>`
144145
- these are types for the core primitive classes
145146
- **`SignalyFn<V>`**can be `SignalFn<V>` or `DerivedFn<V>` or `LazyFn<V>`
146-
- these `*Fn` types are for the hipster-syntax enabled variants
147+
- these `*Fn` types are for the hipster-fn-syntax enabled variants
147148

148149

149150

0 commit comments

Comments
 (0)