@ulu/frontend 0.1.0-beta.12 → 0.1.0-beta.121

package/GEMINI.md

@@ -0,0 +1,9 @@
+You are writing code for a frontend CSS library that is agnostic of framework (ie. Vue, React, etc). The library is composed of:
+
+- `scss/` Sass modules, with annotations written in SASS Doc syntax
+- `js/` Javascript modules for traditional sites (ie. CMS, Drupal, Static, etc) basically not apps. Although some of these utilities are utilized in the vue implementation of this library (outside this projects scope)
+- `docs-src` The eleventy docs site that has the API documentation for scss and javascript (automatically generated) and the `docs-src/content/demos` where tests and examples are built.
+
+## If writing a demo
+
+Demos are markdown or html files within `docs-src/content/demos`. They include frontmatter (YAML) at the beginning of the file to store page meta information. When writing demos do not add inline styles (unless the component requires/uses them) or additional stylesheets. Each demo should just be a basic test of the features the component or script provides.

package/README.dev.md

@@ -8,9 +8,9 @@
 
 ## Docs
 
-## Updatiing SCSS
+## Updating SCSS
 
-- Udpate sassdocs markdown by `npm run docs:update:scss`
+- Update sassdocs markdown by `npm run docs:update:scss`
 
 ## Updating JS Docs
 
@@ -19,4 +19,4 @@
 
 ## Building/Deploying
 
-- Use `npm run docs:build`
+- Use `npm run docs:build`

package/README.md

@@ -1,10 +1,20 @@
-# Frontend Library
+# @ulu/frontend
 
-Front end development library (SCSS, JS)
+Versatile frontend toolkit designed for a variety of web development scenarios.
+
+[Full Documentation](https://jscherbe.github.io/frontend/)
+
+## key Features
+
+- **Target Environment:** The JavaScript "UI" modules are specifically tailored for traditional sites, such as static websites and CMS-driven platforms. However, the comprehensive SCSS modules are fully compatible and can be utilized in modern JavaScript applications built with frameworks like React or Vue.
+- **Configuration & Consistency:** The system's main goal is to allow for highly flexible, per-site configuration while maintaining a consistent set of accessible and high-quality components.
+- **Flexible Usage:** This library is designed as a toolkit, offering the flexibility to be used as a complete stylesheet solution or to pick and choose individual SCSS modules and components as needed.
+- **Integration Adaptability:** All SCSS base selectors (for components, utilities, etc.) can be easily adjusted, making it highly adaptable for seamless integration into pre-existing systems and diverse development environments.
+- API Documentation for both SCSS and JS with examples
+
+## Related Links
 
 - [Documentation](https://jscherbe.github.io/frontend/)
 - [Change Log](CHANGELOG.md)
 - [Development Notes](README.dev.md)
 
-
-