Update README + composer.json for v10

allejo · allejo · commit 44edc5962b59 · 2020-10-10T14:43:22.000-07:00
diff --git a/README.md b/README.md
@@ -6,18 +6,20 @@
 
 *highlight.php* is a server-side syntax highlighter written in PHP that currently supports 185 languages. It's a port of [highlight.js](http://www.highlightjs.org) by Ivan Sagalaev that makes full use of the language and style definitions of the original JavaScript project.
 
+> This is the README for highlight.php v10, which is currently under development. The latest stable release is the [9.18.x series](https://github.com/scrivo/highlight.php/tree/9.18).
+
 [TOC]: # "## Table of Contents"
 
 ## Table of Contents
 - [Installation + Setup](#installation--setup)
-    - [Composer Version Constraints](#composer-version-constraints)
+  - [Composer Version Constraints](#composer-version-constraints)
 - [Usage](#usage)
-    - [Explicit Mode](#explicit-mode)
-    - [Automatic Language Detection Mode](#automatic-language-detection-mode)
-    - [Stylesheets](#stylesheets)
+  - [Explicit Mode](#explicit-mode)
+  - [Automatic Language Detection Mode](#automatic-language-detection-mode)
+  - [Stylesheets](#stylesheets)
 - [Highlighter Utilities](#highlighter-utilities)
 - [Versioning](#versioning)
-    - [Backward Compatibility Promise](#backward-compatibility-promise)
+  - [Backward Compatibility Promise](#backward-compatibility-promise)
 - [Some History](#some-history)
 - [License](#license)
 
@@ -90,16 +92,7 @@ echo "</code></pre>";
 
 #### Default Languages
 
-In version 9.x of this project, the following languages are the default auto-detected languages:
-
-- XML
-- JSON
-- JavaScript
-- CSS
-- PHP
-- HTTP
-
-These default languages are considered "legacy behavior" and will be removed in version 10.x of this library to match highlight.js behavior; the new default behavior in 10.x will be to use *every* language.
+If no autodetect languages are set in the highlighter, then every language will be used and cause significant performance issues.
 
 ### Stylesheets
 
@@ -111,12 +104,13 @@ The core of the project is loyal port of **highlight.js** and is available under
 
 Available functions:
 
-- [`getAvailableStyleSheets(bool $filePaths = false): string[]`](HighlightUtilities/functions.php#L35-L48)
-- [`getStyleSheet(string $name): false|string`](HighlightUtilities/functions.php#L94-L107)
-- [`getStyleSheetFolder(): string`](HighlightUtilities/functions.php#L115-L123)
-- [`getStyleSheetPath(string $name): string`](HighlightUtilities/functions.php#L131-L143)
-- [`getThemeBackgroundColor(string $name): float[]`](HighlightUtilities/functions.php#L75-L88)
-- [`splitCodeIntoArray(string $html): false|string[]`](HighlightUtilities/functions.php#L156-L169)
+- [`getAvailableStyleSheets(bool $filePaths = false): string[]`](src/HighlightUtilities/Functions.php#L40-L53)
+- [`getStyleSheet(string $name): false|string`](src/HighlightUtilities/Functions.php#L101-L114)
+- [`getStyleSheetFolder(): string`](src/HighlightUtilities/Functions.php#L122-L130)
+- [`getStyleSheetPath(string $name): string`](src/HighlightUtilities/Functions.php#L150-L162)
+- [`getLanguageFolder(): string`](src/HighlightUtilities/Functions.php#L136-L144)
+- [`getThemeBackgroundColor(string $name): float[]`](src/HighlightUtilities/Functions.php#L80-L93)
+- [`splitCodeIntoArray(string $html): false|string[]`](src/HighlightUtilities/Functions.php#L175-L188)
 
 ## Versioning
 
diff --git a/composer.json b/composer.json
@@ -55,5 +55,10 @@
     },
     "suggest": {
         "ext-dom": "Needed to make use of the features in the utilities namespace"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "10.0-dev"
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,5 +55,10 @@`
`55`	`55`	`},`
`56`	`56`	`"suggest": {`
`57`	`57`	`"ext-dom": "Needed to make use of the features in the utilities namespace"`
	`58`	`+ },`
	`59`	`+ "extra": {`
	`60`	`+ "branch-alias": {`
	`61`	`+ "dev-master": "10.0-dev"`
	`62`	`+ }`
`58`	`63`	`}`
`59`	`64`	`}`