Merge pull request #2 from fxhash/dev

dev -> main

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "pnpm"
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Create Release Pull Request
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: pnpm run version
+          publish: pnpm run release
+          commit: "chore: release"
+          title: "chore: create new release"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main, dev]
+
+jobs:
+  build:
+    name: Build and Test
+    timeout-minutes: 15
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm -r build
+
+      - name: Tests
+        run: pnpm -r test

.gitignore

@@ -0,0 +1 @@
+node_modules/

doc/README.md

@@ -1,24 +1,3 @@
-```
-Getting started (overview of the resources + the ONCHFS system)
-Overview
-Concepts
-  Hashing
-  Content-Store
-  File-Objects
-  CIDs
-  URIs
-  HTTP Proxy
-Use-cases
-  Support for libraries
-  Cross-chain compatibility
-Known Limitations
-  Content Availability
-  Ecosystem support
-Motivations
-
-onchfs js
-```
-
 # Website
 
 This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

doc/docusaurus.config.js

@@ -6,20 +6,20 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula")
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: "My Site",
-  tagline: "Dinosaurs are cool",
+  title: "ONCHFS — On-Chain for Http File System",
+  tagline: "A file system for blockchains.",
   favicon: "img/favicon.ico",
 
   // Set the production url of your site here
-  url: "https://your-docusaurus-test-site.com",
+  url: "https://onchfs.com",
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: "/",
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: "facebook", // Usually your GitHub org/user name.
-  projectName: "docusaurus", // Usually your repo name.
+  organizationName: "fxhash",
+  projectName: "onchfs",
 
   onBrokenLinks: "throw",
   onBrokenMarkdownLinks: "warn",
@@ -47,7 +47,7 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
-            "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
+            "https://github.com/fxhash/onchfs/tree/main/doc/templates/shared/",
         },
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
@@ -64,10 +64,10 @@ const config = {
       image: "img/docusaurus-social-card.jpg",
       navbar: {
         title: "ONCHFS",
-        logo: {
-          alt: "My Site Logo",
-          src: "img/logo.svg",
-        },
+        // logo: {
+        //   alt: "My Site Logo",
+        //   src: "img/logo.svg",
+        // },
         items: [
           {
             type: "docSidebar",
@@ -88,7 +88,7 @@ const config = {
             label: "Libraries",
           },
           {
-            href: "https://github.com/facebook/docusaurus",
+            href: "https://github.com/fxhash/onchfs",
             label: "GitHub",
             position: "right",
           },
@@ -101,9 +101,17 @@ const config = {
             title: "Docs",
             items: [
               {
-                label: "Tutorial",
+                label: "Getting started",
                 to: "/docs/intro",
               },
+              {
+                label: "Concepts",
+                to: "/docs/concepts/hashing",
+              },
+              {
+                label: "Libraries",
+                to: "/docs/libraries/overview",
+              },
             ],
           },
           {
@@ -128,12 +136,12 @@ const config = {
             items: [
               {
                 label: "GitHub",
-                href: "https://github.com/facebook/docusaurus",
+                href: "https://github.com/fxhash/onchfs",
               },
             ],
           },
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
+        copyright: `Copyright © ${new Date().getFullYear()} fxhash. Built with Docusaurus.`,
       },
       prism: {
         theme: lightCodeTheme,

doc/src/pages/index.tsx

@@ -19,7 +19,7 @@ function HomepageHeader() {
             className="button button--secondary button--lg"
             to="/docs/intro"
           >
-            Docusaurus Tutorial - 5min ⏱️
+            Learn more about ONCHFS
           </Link>
         </div>
       </div>

examples/http-proxy/.gitignore

@@ -1 +1,2 @@
-dist/
+dist/
+node_modules/

examples/test-project/.gitignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

package.json

@@ -0,0 +1,13 @@
+{
+  "name": "root",
+  "private": true,
+  "license": "MIT",
+  "packageManager": "[email protected]",
+  "scripts": {
+    "version": "pnpm changeset version && pnpm install --lockfile-only",
+    "release": "pnpm -r build && pnpm changeset publish"
+  },
+  "devDependencies": {
+    "@changesets/cli": "2.26.2"
+  }
+}

packages/onchfs-js/.gitignore

@@ -1 +1,2 @@
 dist/
+node_modules/

packages/onchfs-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onchfs",
-  "version": "1.0.0",
+  "version": "0.0.0",
   "exports": {
     ".": {
       "require": "./dist/index.js",