Skip to content
This repository was archived by the owner on Aug 27, 2025. It is now read-only.

Commit 5ce8fca

Browse files
committed
feat: update readme
1 parent f43acf3 commit 5ce8fca

1 file changed

Lines changed: 64 additions & 9 deletions

File tree

README.md

Lines changed: 64 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,71 @@
1-
# Vue 3 + TypeScript + Vite
1+
<p align='center'>
2+
<img src="https://raw.githubusercontent.com/NaturalSelectionLabs/CrossSync/b600f5dd2b7e8c38886a7ea58b5589577e4fabb5/src/assets/logo.png" alt="CrossSync Logo" width="60" height="60" />
3+
</p>
24

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
5+
<h1 align='center'>CrossSync</h1>
46

5-
## Recommended IDE Setup
7+
> Welcome to CrossSync! 👋
68
7-
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
9+
<span align='center'>
810

9-
## Type Support For `.vue` Imports in TS
11+
[![test-build](https://img.shields.io/github/workflow/status/NaturalSelectionLabs/CrossSync/Build%20test%20pack?label=test%20build&style=for-the-badge)](https://github.com/NaturalSelectionLabs/CrossSync/actions/workflows/build-test.yml)
12+
[![release-build](https://img.shields.io/github/workflow/status/NaturalSelectionLabs/CrossSync/Build%20release%20pack?label=release%20build&style=for-the-badge)](https://github.com/NaturalSelectionLabs/CrossSync/actions/workflows/build-release.yml)
13+
[![release](https://img.shields.io/github/v/release/NaturalSelectionLabs/CrossSync?color=%235d66f5&style=for-the-badge)](https://github.com/NaturalSelectionLabs/CrossSync/releases)
14+
[![chrome web store](https://img.shields.io/chrome-web-store/v/cilehfhekljoecdbbimgebbncpjagmon?color=%23f55d66&style=for-the-badge)](https://chrome.google.com/webstore/detail/crosssync/cilehfhekljoecdbbimgebbncpjagmon)
1015

11-
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
16+
[![available in chrome web store](https://storage.googleapis.com/chrome-gcs-uploader.appspot.com/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png)](https://chrome.google.com/webstore/detail/crosssync/cilehfhekljoecdbbimgebbncpjagmon)
1217

13-
1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
14-
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
18+
</span>
1519

16-
You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
20+
---
21+
22+
## 🍭 Introduction
23+
24+
CrossSync is a socially-oriented web3 Dapp that runs on the Crossbell. CrossSync aims to allow a user-owned flow of social information.
25+
26+
Crossbell allows users the ability to take back their data ownership; CrossSync makes owning your data a fun and engaging social experience.
27+
28+
To get started, you’ll need go to [Crossbell Faucet](https://faucet.crossbell.io) and get some $CSB. After you’ve connected your wallet and received the $CSB, you’ll be able to mint a profile on CrossSync.
29+
30+
## 🎁 Installation
31+
32+
The latest stable version can be grabbed from [Release Page](https://github.com/NaturalSelectionLabs/CrossSync/releases) with zipped file attached.
33+
34+
You can also migrate to [Chrome Web Store](https://chrome.google.com/webstore/detail/crosssync/cilehfhekljoecdbbimgebbncpjagmon) for the published version. It might have some latency than the Release version because Google need to review it before publish.
35+
36+
## ⚙ Development
37+
38+
1. Build dev pack
39+
40+
- pnpm (recommended)
41+
42+
```shell
43+
pnpm install
44+
pnpm dev
45+
```
46+
47+
2. Navigate to `chrome://extensions/`
48+
49+
3. Open `Developer mode` in the top right corner
50+
51+
4. Click `Load unpacked` in the top left corner
52+
53+
5. Select `path/to/CrossSync/dist`
54+
55+
## 🔨 Builds
56+
57+
### Release builds
58+
59+
You can navigate to [Release page](https://github.com/NaturalSelectionLabs/CrossSync/releases) for the release packs.
60+
61+
### Test builds
62+
63+
You can navigate to [Workflow Run page](https://github.com/NaturalSelectionLabs/CrossSync/actions/workflows/build-test.yml) for the test artifacts. If they are expired, you can build your own pack.
64+
65+
### Build by yourself
66+
67+
- pnpm (recommended)
68+
69+
```shell
70+
pnpm build
71+
```

0 commit comments

Comments
 (0)