Skip to content

Commit e82160c

Browse files
Update README.md
1 parent aa4391b commit e82160c

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,64 @@
1+
<a href="https://www.cortex-ia.co.uk/" target="_blank"><img src="https://github.com/CortexIATest/CTXImages/blob/master/Cortex-350-120.png" alt="Welcome to Cortex!" width="350" height="120" border="0"></a>
2+
13
# CTX-Logging
2-
This module contains a Cortex subtask which allows users to log information to the database in a structured format.
4+
This module contains a Cortex subtask which allows users to log information to the database in a structured format
5+
6+
## Table of Contents
7+
1) [Dependencies](#dependencies)
8+
* [Cortex Version](#cortex-version)
9+
* [OCIs](#ocis)
10+
* [Files](#files)
11+
* [Other](#other)
12+
1) [Installation](#installation)
13+
1) [How to use](#how-to-use)
14+
1) [How you can contribute](#how-you-can-contribute)
15+
1) [Versioning](#versioning)
16+
1) [Licensing](#licensing)
17+
18+
## Dependencies
19+
### Cortex Version
20+
This version of the CTX-Logging module was developed in Cortex v6.4.0. Some functionality may not be available in other verions of Cortex.
21+
22+
### OCIs
23+
The CTX-Logging module requires a SQL database
24+
25+
### Files
26+
The CTX-Logging module requires the following files:
27+
* [CTX-Logging Studio Package](https://github.com/CortexIntelligentAutomation/CTX-Logging/releases/download/v1.0/CTX-Logging.studiopkg)
28+
* [CTX-Logging Database create script](https://github.com/CortexIntelligentAutomation/CTX-Logging/releases/download/v1.0/Cortex-Logging-Install.sql)
29+
30+
### Other Requisites
31+
The CTX-Logging module has no additional requirements
32+
33+
## Installation
34+
Details of how the module should be imported into Cortex can be found in the [Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-Logging/blob/master/CTX-Logging%20-%20Deployment%20Plan.pdf).
35+
36+
## How to use
37+
A detailed User Guide has been provided with instructions on how to use the module, available [here](https://github.com/CortexIntelligentAutomation/CTX-Logging/blob/master/CTX-Logging%20-%20User%20Guide.pdf). Configuring the subtask's inputs and outputs are detailed in notes on the subtask workspace.
38+
39+
## How you can contribute
40+
Unfortunately, we cannot offer pull requests at this time or accept any improvements.
41+
42+
## Versioning
43+
The CTX-Logging module has the following versions, starting with the most recent:
44+
45+
Version | Release | Functionality | Notes
46+
------------ | ------------- | ----------- | -----------
47+
v1.0 | 04/12/2018 | Cortex logging | Created
48+
49+
## Licensing
50+
All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
51+
52+
Copyright 2018 Cortex Limited
53+
54+
Licensed under the Apache License, Version 2.0 (the "License");
55+
you may not use this file except in compliance with the License.
56+
You may obtain a copy of the License at
57+
58+
http://www.apache.org/licenses/LICENSE-2.0
59+
60+
Unless required by applicable law or agreed to in writing, software
61+
distributed under the License is distributed on an "AS IS" BASIS,
62+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
63+
See the License for the specific language governing permissions and
64+
limitations under the License.

0 commit comments

Comments
 (0)