README.md

Developing the Glean JavaScript SDK

This documentation is meant for Glean.js developers.

For user documentation on the Glean SDKs, refer to The Glean Book.

🚧 UNDER CONSTRUCTION 🚧

This documentation is still under construction. See anything missing? Please file a bug, but first check if we don't already have a similar bug open on the list of open documentation bugs open for Glean.js.

Table of contents

Guides

• Contribution guide
• Getting started
• Adding a new metric type
• Updating glean_parser
• Making a new release

Reference

• Continuous Integration
• Metrics collected by Glean.js
• Estimated bundle sizes
• Compatibility

Implementation Details

• Ping Uploading
• Plugins and Core Events
• Bundle size considerations