Skip to content

Commit 16eafd5

Browse files
committed
update readme
1 parent 103117a commit 16eafd5

3 files changed

Lines changed: 11 additions & 18 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,6 @@ exstatic-*.tar
2727

2828
# Shared binary artifacts (compiled NIFs).
2929
priv/native/*.so
30+
31+
# Ignore checksum file
32+
checksum-*.exs

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ Normal.variance(dist) # => 1.0
3636

3737
- Elixir ~> 1.18
3838

39-
Precompiled NIF binaries are included for common platforms. No additional system dependencies are required for normal usage.
40-
4139
Add `exstatic` to your list of dependencies in `mix.exs`:
4240

4341
```elixir
@@ -48,9 +46,14 @@ def deps do
4846
end
4947
```
5048

49+
Precompiled NIF binaries are included in releases for common platforms. Downloading precompiled binaries requires you have read access to this repository,
50+
you must set the environment variable `EXSTATIC_GITHUB_TOKEN` with a GitHub Personal Access Token (PAT) with sufficient privileges -
51+
please see [here](https://github.com/Intellection/exstatic/blob/main/docs/github_token_guide.md) for more details.
52+
53+
5154
## Documentation
5255

53-
Full documentation can be found at [https://hexdocs.pm/exstatic](https://hexdocs.pm/exstatic).
56+
Full documentation can be found at [https://zappi.hexdocs.pm/exstatic](https://zappi.hexdocs.pm/exstatic).
5457

5558
## Development
5659

@@ -66,9 +69,9 @@ Full documentation can be found at [https://hexdocs.pm/exstatic](https://hexdocs
6669
```bash
6770
mix deps.get
6871
```
69-
3. Compile the project:
72+
3. Compile the project (set `EXSTATIC_BUILD=true` to build Rust code):
7073
```bash
71-
mix compile
74+
EXSTATIC_BUILD=true mix compile
7275
```
7376
4. Run tests:
7477
```bash

RELEASE.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,3 @@ mix hex.publish # Publish the package
6868
### Important Notes:
6969
- You **must have write access** to Zappi's Hex registry to publish (ask Brendon if you don't).
7070
- **Ensure you are on the `main` branch**, and it matches `origin/main`, as `mix hex.publish` publishes from your **local copy**, not GitHub.
71-
72-
## **6️⃣ Verify Installation**
73-
74-
To confirm users can fetch precompiled NIFs **without needing Rust**, test in a fresh clone:
75-
76-
```sh
77-
git clone https://github.com/Intellection/exstatic.git
78-
cd exstatic
79-
mix deps.get
80-
mix compile # Should download precompiled NIFs instead of compiling Rust
81-
```
82-
83-
If this works **without recompiling Rust**, the release is successful! 🎉

0 commit comments

Comments
 (0)