Skip to content

Commit

Permalink
removing emojis to publish
Browse files Browse the repository at this point in the history
  • Loading branch information
lmajano committed Feb 13, 2024
1 parent c7ce6a6 commit e1c8783
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 14 deletions.
6 changes: 3 additions & 3 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Removal of `box.zip` in root from old scripts

### BREAKING
### BREAKING

- Dropped support for Adobe 2016. Adobe doesn't support ACF 16 anymore, so neither do we.

### 📦 NEW
### NEW

- Added support for Adobe 2021
- Added support for `@myCustomTag` custom docblock tags on methods. (Already supported on components and properties, but missing on methods).
- Added GitHub Actions CI for automated testing, format checking, releases and more

### 🐛 FIX
### FIX

- Fixes support for Adobe 2018. (Mainly in the CommandBox strategy.)

Expand Down
19 changes: 8 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
[![All Contributors](https://img.shields.io/github/contributors/Ortus-Solutions/DocBox?style=flat-square)](https://github.com/michaelborn/DocBox/graphs/contributors)
|
[![Master Branch Build Status](https://img.shields.io/travis/Ortus-Solutions/DocBox/master.svg?style=flat-square&label=master)](https://travis-ci.org/Ortus-Solutions/DocBox)
|
[![Development Branch Build Status](https://img.shields.io/travis/Ortus-Solutions/DocBox/development.svg?style=flat-square&label=development)](https://travis-ci.org/Ortus-Solutions/DocBox)
|
![Latest release](https://img.shields.io/github/v/release/Ortus-Solutions/DocBox?style=flat-square)

```text
██████╗ ██████╗ ██████╗██████╗ ██████╗ ██╗ ██╗
██╔══██╗██╔═══██╗██╔════╝██╔══██╗██╔═══██╗╚██╗██╔╝
██║ ██║██║ ██║██║ ██████╔╝██║ ██║ ╚███╔╝
██║ ██║██║ ██║██║ ██╔══██╗██║ ██║ ██╔██╗
██║ ██║██║ ██║██║ ██████╔╝██║ ██║ ╚███╔╝
██║ ██║██║ ██║██║ ██╔══██╗██║ ██║ ██╔██╗
██████╔╝╚██████╔╝╚██████╗██████╔╝╚██████╔╝██╔╝ ██╗
╚═════╝ ╚═════╝ ╚═════╝╚═════╝ ╚═════╝ ╚═╝ ╚═╝
```
Expand All @@ -33,16 +29,16 @@ DocBox is a JavaDoc-style documentation generator for your CFML codebase based o

## SYSTEM REQUIREMENTS

- Lucee 5+
- ColdFusion 2016+
* Lucee 5+
* ColdFusion 2016+

## Usage

Use the DocBox library to generate API docs from your CFC files. Install Docbox with CommandBox like so:

```bash
box install docbox
```
```

### Standalone Application

Expand All @@ -55,8 +51,8 @@ docbox = new docbox.DocBox( strategy="class.path", properties={} );
// create with HTML strategy
docbox = new docbox.DocBox(
strategy = "HTML",
properties = {
projectTitle="My Docs",
properties = {
projectTitle="My Docs",
outputDir="#expandPath( '/docs' )#"
}
);
Expand Down Expand Up @@ -103,6 +99,7 @@ There is a related project you can install which wraps up the DocBox library in
```bash
box install commandbox-docbox
```

Read more here: https://github.com/Ortus-Solutions/commandbox-docbox

----
Expand Down

0 comments on commit e1c8783

Please sign in to comment.