andras/reconcile
1
0
Fork 0
Code Issues Pull requests 5 Projects Releases Packages Wiki Activity Actions

Fix NPM readme

Browse source
This commit is contained in:
Andras Schmelczer 2025-07-10 21:14:01 +01:00
parent 5754f4f7cf
commit fe2642fff9
No known key found for this signature in database
GPG key ID: FC8F2C3D3D1A718C
2 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/check.yml vendored
View file

@ -137,6 +137,7 @@ jobs:
- name: Publish reconcile-js to NPM - name: Publish reconcile-js to NPM
run: | run: |
cd reconcile-js cd reconcile-js
cp ../README.md .
npm publish npm publish
env: env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

16
README.md
View file

@ -1,7 +1,4 @@
# Reconcile: conflict-free 3-way text merging # Reconcile-text: conflict-free 3-way text merging
[![Check](https://github.com/schmelczer/reconcile/actions/workflows/check.yml/badge.svg)](https://github.com/schmelczer/reconcile/actions/workflows/check.yml)
[![Publish to GitHub Pages](https://github.com/schmelczer/reconcile/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/schmelczer/reconcile/actions/workflows/gh-pages.yml)
> Think [`diff3`](https://www.gnu.org/software/diffutils/manual/html_node/Invoking-diff3.html) or `git merge`, but with intelligent conflict resolution that just works. > Think [`diff3`](https://www.gnu.org/software/diffutils/manual/html_node/Invoking-diff3.html) or `git merge`, but with intelligent conflict resolution that just works.
@ -9,7 +6,10 @@ Reconcile is a Rust and JavaScript (via WebAssembly) library that merges conflic
✨ **[Try the interactive demo](https://schmelczer.dev/reconcile)** to see it in action! ✨ **[Try the interactive demo](https://schmelczer.dev/reconcile)** to see it in action!
TODO: add links for crates and npm Find it on:
- [reconcile-text on crates.io](https://crates.io/crates/reconcile-text)
- [reconcile-text on NPM](https://www.npmjs.com/package/reconcile-text)
## What makes Reconcile special? ## What makes Reconcile special?
@ -23,7 +23,7 @@ TODO: add links for crates and npm
### Rust ### Rust
Add `reconcile-text` to your `Cargo.toml`: Run `cargo add reconcile-text` or add `reconcile-text` to your `Cargo.toml`:
```toml ```toml
[dependencies] [dependencies]
@ -167,6 +167,8 @@ Here's the key insight: whilst incorrect merges in source code can introduce dev
- **Build demo website**: `scripts/build-website.sh` - **Build demo website**: `scripts/build-website.sh`
- **Publish new version**: `scripts/bump-version.sh patch` - **Publish new version**: `scripts/bump-version.sh patch`
TODO: license ## License
[MIT](./LICENSE)
[¹]: https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/35605.pdf [¹]: https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/35605.pdf