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

Update Readme #268

Merged
merged 3 commits into from
Feb 19, 2025
Merged

Update Readme #268

merged 3 commits into from
Feb 19, 2025

Conversation

iesahin
Copy link
Owner

@iesahin iesahin commented Feb 19, 2025

  • Fix some links
  • Updated mentioned crates and license section
  • add gix to the list

Description by Callstackai

This PR updates the README file to fix links, update mentioned crates, and add 'gix' to the list.

Diagrams of code changes
sequenceDiagram
    actor User
    participant Xvc
    participant Git
    participant Storage
    participant Pipeline

    User->>Xvc: xvc init
    Note over Xvc: Creates .xvc/ directory and .xvcignore

    User->>Xvc: xvc file track my-data/
    Xvc->>Xvc: Calculate BLAKE-3 hashes
    Xvc->>Git: Hide binary files from Git

    User->>Xvc: xvc file copy/recheck
    Note over Xvc: Creates different views of data<br/>using symlinks/hardlinks

    User->>Xvc: xvc storage new
    Xvc->>Storage: Configure cloud storage<br/>(S3/GCS/R2/etc)

    User->>Xvc: xvc file send
    Xvc->>Storage: Upload files to configured storage

    User->>Xvc: xvc pipeline new
    Xvc->>Pipeline: Define pipeline steps and dependencies
    Note over Pipeline: Supports file/glob/line/URL/SQLite<br/>and custom dependencies
Loading
Files Changed
FileSummary
README.mdUpdated links, mentioned crates, and added 'gix' to the list.

This PR includes files in programming languages that we currently do not support. We have not reviewed files with the extensions .md. See list of supported languages.

Copy link

netlify bot commented Feb 19, 2025

Deploy Preview for xvc canceled.

Name Link
🔨 Latest commit 92e1fc5
🔍 Latest deploy log https://app.netlify.com/sites/xvc/deploys/67b5a8eecedc8b0008987e3a

@iesahin iesahin merged commit 358d584 into main Feb 19, 2025
7 checks passed
@iesahin iesahin deleted the update-readme-16654 branch February 19, 2025 09:49
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.28%. Comparing base (befbaa0) to head (92e1fc5).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #268      +/-   ##
==========================================
+ Coverage   71.24%   71.28%   +0.04%     
==========================================
  Files         126      126              
  Lines       14326    14326              
==========================================
+ Hits        10207    10213       +6     
+ Misses       4119     4113       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant