Pebble

A (S)crappy SCSS to dump CSS for linking using CDN.

Description

Pebble is a simple and straightforward tool for compiling SCSS into CSS and managing stylesheets via CDN. It leverages modern SCSS capabilities and provides an easy way to build and watch SCSS files.

Table of Contents

• Installation
• Usage
• Scripts
• Contributing
• License
• Author
• Versioning
• Update Script

Installation

To get started with Pebble, clone the repository and install the dependencies.

git clone https://github.com/32teeth/Pebble.git
cd Pebble
npm install

Ensure you have Node.js 20.x and npm 10.x installed on your machine.

Usage

Building SCSS

To build the SCSS files into CSS, run the following command:

npm run sass:build

Watching SCSS

To watch the SCSS files and automatically build on changes, run:

npm run sass:watch

Scripts

• sass:build: Compiles SCSS files into CSS and outputs them to the public/css directory.
• sass:watch: Watches for changes in SCSS files and recompiles them automatically.
• sass: Runs the sass:watch script.

Contributing

If you would like to contribute to Pebble, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.

License

This project is licensed under the ISC License. See the LICENSE file for details.

Author

• Eugene Yevhen Andruszczenko - 32teeth
• Email: eugene.andruszczenko@gmail.com

Contributors

• 32teeth - 32teeth
• Email: eugene.andruszczenko@gmail.com

Versioning

This project uses Semantic Versioning. For the versions available, see the tags on this repository.

Update Script

An update script (update.sh) is included to automate versioning, changelog generation, and releasing.

How to Use the Update Script

To use the update script, run:

./update.sh

The script will perform the following steps:

1. Version Update: It will read the current version from package.json, increment the patch version (or minor/major if necessary), and update the package.json file with the new version.
2. Changelog Update: It will generate a new entry in the CHANGELOG.md file with placeholder changes.
3. Build SCSS: It will run npm run sass:build to compile the SCSS files.
4. GitHub Release: It will commit the changes, tag the new version, and create a new GitHub release with autogenerated notes.

For more details on how the update script works, refer to the update.sh file.

---

Thank you for using Pebble! If you have any questions or need further assistance, feel free to open an issue on GitHub.