basic repo setup

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = tab
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true

.prettierignore

@@ -0,0 +1,6 @@
+README.md
+CONTRIBUTING.md
+CODE_OF_CONDUCT.md
+.svelte-kit
+.changeset
+CHANGELOG.md

.prettierrc

@@ -0,0 +1,23 @@
+{
+  "useTabs": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "semi": false,
+  "singleAttributePerLine": true,
+  "plugins": ["prettier-plugin-astro", "prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    },
+    {
+      "files": "*.svelte",
+      "options": {
+        "parser": "svelte"
+      }
+    }
+  ]
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# How to contribute
+
+## Setting up a dev environment
+
+Setting up the repo:
+
+1. **Clone** the repo with `git clone [email protected]:jerzakm/threejs-kit.git`
+2. **Install** the packages by running `pnpm install` in the root of the repo
+3. **Develop** by running `pnpm run dev`
+
+Some editor tooling:
+
+1. **Editor Configuration**: install the [`editorconfig`](https://editorconfig.org/) extension for your editor.
+2. **VSCode Users**: install the recommended extensions.
+
+## Commiting changes
+
+Three.js-kit uses Git for version control and [Changesets](https://github.com/changesets/changesets) for release notes. You will need to understand our conventions with both to commit changes.
+
+### Git commits
+
+We don't have a strict commit message policy. Here are some best practices:
+
+- **Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)** to make it easier to read your commit message.
+- **Go into technical details** if necessary to allow maintainers to understand the context of the change.
+
+### Changesets
+
+[Changesets](https://github.com/changesets/changesets) is a tool that helps us keep a changelog for all the packages in the monorepo and aggregate them into release notes.
+
+To add a changeset:
+
+1. **Run the command** `npx changeset` in your terminal
+2. **Select packages** affected by your change; we have a dedicated package for the docs.
+3. **Classify the change** as major, minor, or patch for each selected package.
+4. **Write the changelog** as detailing WHAT the change is, WHY it was made, and HOW it affects the users.
+5. **Commit the changeset file** to your Git branch so that it appears in your PR.
+
+Make an effort to write the changelog well, because our users see this in the release notes. Provide enough detail to be clear, but keep things as concise as possible. If migration steps are required, detail them here.
+
+A detailed guide on adding changesets can be [found here](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).

README.md

@@ -1,6 +1,33 @@
-# three-kit
+# threejs-kit
 
-Three.js materials, shaders and utils. Readme wip
+Three.js kit is a set of addons such as materials, shaders and other utilities for Three.js.
+
+# Features:
+
+## [InstancedSpriteMesh]((https://three-kit.vercel.app/instancedsprite/01-instanced-sprite-mesh/))
+`npm i @threejs-kit/instanced-sprite-mesh`
+
+High performant instancing of animated sprites in threejs.
+
+[Documentation]
+
+
+## Materials
+`npm i @threejs-kit/materials`
+
+
+### [MeshGlintMaterial](https://three-kit.vercel.app/materials/glint-material/)
+
+Real-time realistic glint material for three.js based on "Procedural Physically based BRDF for Real-Time Rendering of Glints" by Xavier Chermain et al.
+
+![MeshGlintMaterial preview](https://three-kit.vercel.app/glint.png)
+
+
+
+### [MeshParallaxMaterial](https://three-kit.vercel.app/materials/parallax-material/)
+
+Creates convincing illusion of depth, surface irregularities, and geometric complexity,
+without increasing polygon count.
+
+![MeshParallaxMaterial preview](https://three-kit.vercel.app/parallax.png)
 
-Materials:
-  - Parallax Occlusion

apps/docs/src/content/docs/index.mdx

@@ -6,12 +6,58 @@ hero:
   title: |
     three.js-kit
 
-  tagline: npm i @threejs-kit/materials
-  image:
-    file: ../../assets/houston.webp
+  tagline: Materials, shaders and other utilities for Three.js
   actions:
     - text: Documentation
       link: /intro/overview/
       icon: right-arrow
       variant: primary
 ---
+
+<div class="grid grid-cols-2 gap-y-10 gap-x-5">
+  <div>
+    # InstancedSpriteMesh
+
+    `npm i @threejs-kit/instanced-sprite-mesh`
+
+    High performant instancing of animated sprites in threejs.
+
+    [Get started](/instancedsprite/01-instanced-sprite-mesh/)
+
+  </div>
+
+
+  <img src="/sprites.jpg"/>
+
+  <div class="col-span-2">
+  # Materials
+    `npm i @threejs-kit/materials`
+  </div>
+
+  <div>
+    [MeshGlintMaterial](/materials/glint-material/)
+
+    Real-time realistic glint material for three.js based on "Procedural Physically based BRDF for Real-Time Rendering of Glints" by Xavier Chermain et al.
+
+  </div>
+
+  <div>
+    <img src="/glint.png"/>
+  </div>
+
+   <div>
+    <img src="/parallax.png"/>
+  </div>
+
+  <div>
+    [MeshParallaxMaterial](/materials/parallax-material/)
+
+    Creates convincing illusion of depth, surface irregularities, and geometric complexity,
+    without increasing polygon count.
+
+
+  </div>
+
+
+</div>
+

package.json

@@ -14,7 +14,10 @@
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
     "eslint": "^7.32.0",
-    "prettier": "^2.5.1",
+    "prettier": "^2.8.8",
+    "prettier-plugin-astro": "^0.13.0",
+    "prettier-plugin-svelte": "^3.1.0",
+    "prettier-plugin-tailwindcss": "^0.5.11",
     "turbo": "latest"
   },
   "packageManager": "[email protected]",