Giter Club home page Giter Club logo

webbundle's Introduction

Web bundles

build

google/webbundle is a project which aims to provide a high-performace library and various tools for handling Web bundles format.

This is not an officially supported Google product.

Specification

Crates

There are several crates in the repository.

crates.io

The core library. See the documentation.

crates.io

The command line tool for packaging resources as Web Bundles.

Installation

Archives of precompiled binaries for webbundle-cli are available for Windows, macOS and Linux.

If you're using Rust, webbundle-cli can be installed with cargo.

cargo install webbundle-cli

Examples

The binary name for webbundle-cli is webbundle.

create

Create example.wbn from the files under build/dist directory. This is similar to tar cvf example.tar build/dist.

$ webbundle create example.wbn build/dist

list

List the contents of example.wbn. This is similar to tar tvf example.tar.

$ webbundle list ./example.wbn

extract

Extract the contents of example.wbn. This is similar to tar xvf example.tar.

$ webbundle extract ./example.wbn

See webbundle --help for detail usage.

crates.io

The experimental web server which dynamically serves Web bundles from underlying resources.

crates.io

The benchmark tool for measuring the browser's loading performance with Web bundles.

TODO

The development is at very early stage. There are many TODO items:

  • Parser
    • Support b2 format
  • Encoder
    • Support b2 format
  • Web Bundles Builder
    • Create a Web Bundle from a directory structure
    • Low-level APIs to create and manipulate Web Bundle file
  • Use http::Request, http::Response and http::Uri for better ergonomics
  • Use async/await to avoid blocking operations
  • More CLI subcommands
    • create
    • list
    • extract
    • Make these subcommands more ergonomics
  • Focus the performance. Avoid copy as much as possible.
  • Split this crate into several crates:
    • webbundle: Core library
    • webbundle-cli: CLI, like a tar command
    • webbundle-ffi: Foreign function interface for C or C++ program, like a chromium.
    • webbundle-server: Experimental http server which can assemble and serve a webbundle dynamically, based on request parameters
    • webbundle-wasm: WebAssembly binding
    • webbundle-bench: The benchmark tool

Contributing

See contributing.md for instructions.

webbundle's People

Contributors

hayatoito avatar kination avatar tomokinat avatar jim4067 avatar irori avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.