Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jackluson committed Dec 7, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 8f3f5ea commit f741549
Showing 7 changed files with 71 additions and 5 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,5 +6,33 @@
![](https://img.shields.io/badge/Typescript-3178C6?style=flat-square&logo=typescript&logoColor=white)
![](https://badges.aleen42.com/src/vitejs.svg)
![GitHub action badge](https://github.com/jackluson/sync-your-cookie/actions/workflows/build-zip.yml/badge.svg)
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/jackluson/sync-your-cookieFactions&count_bg=%23#222222&title_bg=%23#454545&title=😀&edge_flat=true" alt="hits"/>
<!-- <img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/jackluson/sync-your-cookieFactions&count_bg=%23#222222&title_bg=%23#454545&title=😀&edge_flat=true" alt="hits"/> -->

</div>

[English](./README.md) | [中文](./README_ZH.md)

`Sync your cookie` is a chrome extension that helps you to sync your cookie to Cloudflare. It's a useful tool for web developers to share cookies between different devices.


### Features

- Supports syncing cookies to Cloudflare
- Supports configuring `Auto Merge` and `Auto Push` rules for different sites
- Cookie data is transmitted via protobuf encoding
- Provides a management panel to facilitate viewing, copying, and managing synchronized cookie data


### Project Screenshots

Account Settings Page

<img width="600" src="./screenshots/settings.png" alt="account settings"/>

Cookie Sync Popup Page

<img width="600" src="./screenshots/sync.png" alt="cookie sync popup"/>

Cookie Manager Sidebar Panel

<img width="600" src="./screenshots/panel.png" alt="cookie manager sidebar panel"/>
38 changes: 38 additions & 0 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<div align="center">
<img src="chrome-extension/public/icon-128.png" alt="logo"/>
<h1> Sync your cookie to <br/>Cloudflare</h1>
</div>

[English](./README.md) | [中文](./README_ZH.md)

`Sync your cookie` 是一个 Chrome 扩展程序,它可以帮助您将 Cookie 同步到 Cloudflare。它是一个有用的工具,用于在不同设备之间共享 Cookie, 免去了登录流程的烦恼,此外也提供了cookie管理面板查看,管理已经过同步的 cookie。


<!-- // 使用gif展示功能 -->

### 功能
- 支持同步 Cookie 到 Cloudflare
- 支持为不同站点配置`Auto Merge``Auto Push`规则
- Cookie数据经过 protobuf 编码传输
- 提供了一个管理面板,方便查看、复制、管理已经同步的 Cookie 数据

### 项目截图

账号设置页面

<img width="600" src="./screenshots/settings.png" alt="account settings"/>

Cookie 同步页面

<img width="600" src="./screenshots/sync.png" alt="cookie sync popup"/>

Cookie 管理侧边栏面板

<img width="600" src="./screenshots/panel.png" alt="cookie manager sidebar panel"/>

### 使用





6 changes: 3 additions & 3 deletions pages/options/src/Options.tsx
Original file line number Diff line number Diff line change
@@ -76,7 +76,7 @@ const Options = () => {
value={token}
onChange={handleTokenInput}
className="w-full mb-2"
type="text"
type="password"
placeholder="please input your cloudflare token "
required
/>
@@ -98,12 +98,12 @@ const Options = () => {
<div className="grid gap-2">
<div className="flex justify-between items-center ">
<Label htmlFor="namespaceId">Namespace ID</Label>
{namespaceId ? null : (
{/* {namespaceId ? null : (
<div className="text-center ml-16 text-sm">
Don’t have an ID yet?
<span className=" cursor-pointer underline ml-2">Create</span>
</div>
)}
)} */}
</div>
<Input
id="namespaceId"
Binary file added screenshots/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f741549

Please sign in to comment.