Skip to content

Commit

Permalink
chore: change Mapeo references to CoMapeo (#825)
Browse files Browse the repository at this point in the history
  • Loading branch information
EvanHahn authored Sep 17, 2024
1 parent fbb2510 commit 286a8ef
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
npm ci
npm run doc
# TODO: Re-enable this.
# See <https://github.com/digidem/mapeo-core-next/issues/707>.
# See <https://github.com/digidem/comapeo-core/issues/707>.
#
# - name: Push updated markdown docs
# uses: stefanzweifel/git-auto-commit-action@v5
Expand Down
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# Mapeo Core
# CoMapeo Core

> A local-first library for collaborating on mapping projects.
## ⚠️ Early development

This is the next version of @mapeo/core, hosted in its own repo for ease of testing.

This library isn't ready for direct use yet!

## About

Mapeo Core is a library used by the [mobile](https://github.com/digidem/mapeo-mobile) and [desktop](https://github.com/digidem/mapeo-desktop) Mapeo apps that provides the core features needed for offline-first peer to peer collaboration on mapping projects.
CoMapeo Core is a library used by the [mobile](https://github.com/digidem/comapeo-mobile) and [desktop](https://github.com/digidem/comapeo-desktop) CoMapeo apps that provides the core features needed for offline-first peer to peer collaboration on mapping projects.

## Docs

To learn more about Mapeo Core see the [docs](docs/) section of this repo.
To learn more about CoMapeo Core see the [docs](docs/) section of this repo.

## Change log

Expand All @@ -25,7 +19,7 @@ The changes in each version are described in the [change log](CHANGELOG.md).
> **⚠️ Warning:** this package is not ready for use!
```shell
npm i digidem/mapeo-core-next
npm install @comapeo/core
```

## Contributing
Expand Down
4 changes: 2 additions & 2 deletions docs/development/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

## Clone the repo

- `git clone [email protected]:digidem/mapeo-core-next.git`
- `cd mapeo-core-next`
- `git clone [email protected]:digidem/comapeo-core.git`
- `cd comapeo-core`

## Install dependencies

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/digidem/mapeo-core.git"
"url": "git+https://github.com/digidem/comapeo-core.git"
},
"authors": [
"Andrew Chou <[email protected]>",
Expand All @@ -103,9 +103,9 @@
],
"license": "MIT",
"bugs": {
"url": "https://github.com/digidem/mapeo-core/issues"
"url": "https://github.com/digidem/comapeo-core/issues"
},
"homepage": "https://github.com/digidem/mapeo-core#readme",
"homepage": "https://github.com/digidem/comapeo-core#readme",
"devDependencies": {
"@bufbuild/buf": "^1.26.1",
"@mapeo/default-config": "4.0.1-alpha.0",
Expand Down

0 comments on commit 286a8ef

Please sign in to comment.