goalgorilla/rtseo.js

Text analysis application for use with the Real-Time SEO Drupal module.

2.1.0 2018-01-19 23:11 UTC

GPL-3.0

README

Text analysis and assessment library in JavaScript. This library can generate interesting metrics about a text and assess these metrics to give you an assessment which can be used to improve the text.

This library builds on the work done in the Yoast/YoastSEO.js project. The library in this repo is meant to be used with the Real-Time SEO Module for Drupal.

Issues

Any issues for the Drupal module or JavaScript from this repository should be reported in the drupal.org issue queue.

Any issues for the YoastSEO.js library itself should be reported in the YoastSEO.js issue tracker. This distribution may not be the latest version of the YoastSEO.js library for compatibility reasons with the Drupal module so care should be taken that issues may already be fixed in a later release.

Maintainers

This repository is maintained by GoalGorilla and has no affiliation with Yoast or the YoastSEO.js project.

License

This library is distributed under the GPL-3.0 license. Please see License file for more information.

Developer instructions

If you want to modify the Real Time SEO library in this repository, do the following.

Install all dependencies with yarn install. This will ensure that the proper version of the YoastSEO library gets downloaded as well as all development dependencies such as bundler.

Once you are satisfied with your changes, run yarn run bundle to let bundler pull together all the required files. Your result will be in the dist/ folder.