Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: change Mapeo references to CoMapeo #825

Merged
merged 4 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Comment on lines -5 to -10
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just removed this whole section rather than fixing it.


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
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mapeo/core",
"version": "9.0.0-alpha.23",
"name": "@comapeo/core",
"version": "0.0.0",
"description": "Offline p2p mapping library",
"main": "src/index.js",
"types": "dist/index.d.ts",
Expand Down 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": [
"Karissa McKelvey",
Expand All @@ -101,9 +101,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.0-alpha.8",
Expand Down
Loading