Skip to content

Commit 7db25b9

Browse files
committed
docs: replace em dashes with hyphens in package READMEs
1 parent 01619fa commit 7db25b9

44 files changed

Lines changed: 75 additions & 75 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/SquidStd.Abstractions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ Tutorial: [Source generators: registration](https://tgiachi.github.io/squid-std/
4444

4545
## License
4646

47-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
47+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Actors/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ using var sub = session.SubscribeToEventBus(eventBus, (UserJoinedEvent e) => new
7878
- **Isolate**: a throwing handler is logged and skipped; the actor stays alive. `AskAsync` exceptions
7979
always propagate to the caller regardless of policy.
8080

81-
`DisposeAsync` completes the mailbox and drains queued messages every `Tell` runs and every `Ask`
82-
replies within `ShutdownDrainTimeout`. If a handler is still running when that budget elapses, the
81+
`DisposeAsync` completes the mailbox and drains queued messages - every `Tell` runs and every `Ask`
82+
replies - within `ShutdownDrainTimeout`. If a handler is still running when that budget elapses, the
8383
actor cancels its handlers and faults any requests that never completed with `ObjectDisposedException`.
8484

8585
## Related
@@ -89,4 +89,4 @@ actor cancels its handlers and faults any requests that never completed with `Ob
8989

9090
## License
9191

92-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
92+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.AspNetCore/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Each registered `IHealthCheck` appears as its own entry in the report. Check nam
4949
|---------------------------------------|------------------------------------------------------------------------|
5050
| `SquidStdAspNetCoreBuilderExtensions` | `UseSquidStd(...)` builder extension. |
5151
| `SquidStdHostedService` | Hosted service bridging SquidStd service lifecycle to the host. |
52-
| `SquidStdHealthChecksExtensions` | `AddSquidStdHealthChecks(...)` bridge to ASP.NET Core health checks. |
52+
| `SquidStdHealthChecksExtensions` | `AddSquidStdHealthChecks(...)` - bridge to ASP.NET Core health checks. |
5353

5454
## Unified logging (opt-in)
5555

@@ -81,4 +81,4 @@ logger:
8181
8282
## License
8383
84-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
84+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Aws.Abstractions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ client at that endpoint instead of the regional AWS endpoint.
3535

3636
## License
3737

38-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
38+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Caching.Abstractions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ public Task<int> GetOrComputeAsync(ICacheService cache)
3838

3939
## License
4040

41-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
41+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Caching.Redis/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ var user = await cache.GetAsync<object>("user:1");
3939

4040
## License
4141

42-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
42+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Caching/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1 align="center">SquidStd.Caching</h1>
22

33
In-memory backend for SquidStd.Caching. Provides an `IMemoryCache`-backed `ICacheProvider` with
4-
absolute TTL and eviction, wired to the shared typed `ICacheService` facade registered with a
4+
absolute TTL and eviction, wired to the shared typed `ICacheService` facade - registered with a
55
single `AddInMemoryCache()` call. Ideal for single-process apps, tests, and local dev.
66

77
## Install
@@ -38,4 +38,4 @@ var user = await cache.GetAsync<object>("user:1");
3838

3939
## License
4040

41-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
41+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Core/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<h1 align="center">SquidStd.Core</h1>
22

33
Foundational contracts and utilities for the SquidStd stack. It defines the core service interfaces
4-
(configuration, event bus, jobs, timing, metrics, storage) and ships dependency-free helpers YAML/JSON
5-
serialization, a Serilog event sink, and string/environment/directory extensions that the other
4+
(configuration, event bus, jobs, timing, metrics, storage) and ships dependency-free helpers - YAML/JSON
5+
serialization, a Serilog event sink, and string/environment/directory extensions - that the other
66
SquidStd packages build on.
77

88
## Install
@@ -68,4 +68,4 @@ pool.Return(builder);
6868

6969
## License
7070

71-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
71+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Crypto/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ keyring.Import(bobPublicArmored); // a correspondent's public key
3737
string armored = await pgp.EncryptForAsync("bob@example.com", payloadBytes);
3838
byte[] plaintext = await pgp.DecryptAsync(armoredFromBob, "passphrase");
3939

40-
// Sign and verify (signed message the data is embedded in the armored block).
40+
// Sign and verify (signed message - the data is embedded in the armored block).
4141
string signed = await pgp.SignAsync(payloadBytes, "alice@example.com", "passphrase");
4242
var verification = await pgp.VerifyAsync(signed); // verification.IsValid, verification.Data
4343
@@ -52,7 +52,7 @@ await keyring.LoadAsync(container.Resolve<IPgpKeyStore>());
5252

5353
## Password-based encryption
5454

55-
`PasswordCipher` encrypts a payload under a password Argon2id derives the key, AES-256-GCM seals the data,
55+
`PasswordCipher` encrypts a payload under a password - Argon2id derives the key, AES-256-GCM seals the data,
5656
and the result is a self-describing, versioned envelope (salt, nonce, tag and KDF cost are embedded, so
5757
decryption needs only the password and the blob).
5858

@@ -89,14 +89,14 @@ encryption use `CryptoUtils` / `ISecretProtector` instead.
8989

9090
## Key stores
9191

92-
- **`FilePgpKeyStore(directory)`** one armored `.asc` per key (public, plus secret when held). gpg-interoperable.
93-
- **`AesGcmPgpKeyStore(ISecretProtector, path)`** the whole keyring serialized to a single file, encrypted at
92+
- **`FilePgpKeyStore(directory)`** - one armored `.asc` per key (public, plus secret when held). gpg-interoperable.
93+
- **`AesGcmPgpKeyStore(ISecretProtector, path)`** - the whole keyring serialized to a single file, encrypted at
9494
rest with the application key via `SquidStd`'s `ISecretProtector`.
9595

9696
## Notes
9797

9898
- **Signatures are signed messages**, not detached signatures: `SignAsync` embeds the data in the armored block
99-
and `VerifyAsync` recovers it. Verification is **pass/fail** PgpCore does not expose the signer's key id or
99+
and `VerifyAsync` recovers it. Verification is **pass/fail** - PgpCore does not expose the signer's key id or
100100
identity, so the results carry no signer attribution.
101101
- `DecryptAndVerifyAsync` never throws on a bad/absent signature when the ciphertext itself is valid: it always
102102
recovers `Data` and reports `IsSigned` / `IsValid`.
@@ -154,4 +154,4 @@ var folderVault = new CryptoFileSystem(new PhysicalFileSystem("/secure/dir"));
154154

155155
## License
156156

157-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
157+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Database.Abstractions/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<h1 align="center">SquidStd.Database.Abstractions</h1>
22

33
Provider-agnostic data-access contracts for SquidStd. Entities derive from `BaseEntity` (a `Guid` id
4-
plus UTC timestamps) and are accessed through the generic `IDataAccess<TEntity>` full CRUD, bulk
5-
operations, paging, and composable queries without binding to any specific ORM.
4+
plus UTC timestamps) and are accessed through the generic `IDataAccess<TEntity>` - full CRUD, bulk
5+
operations, paging, and composable queries - without binding to any specific ORM.
66

77
## Install
88

@@ -45,4 +45,4 @@ public async Task ExampleAsync(IDataAccess<User> users)
4545

4646
## License
4747

48-
MIT part of [SquidStd](https://github.com/tgiachi/squid-std).
48+
MIT - part of [SquidStd](https://github.com/tgiachi/squid-std).

0 commit comments

Comments
 (0)