docs: Update README.md and LICENSE (#52)

* LICENSE: Set year to match year first published

* docs: Update README.md

* docs: Add markdownlint config

* docs: Update installation section

Author: bkeryan

.markdownlint.yml

@@ -0,0 +1,6 @@
+# MD013/line-length
+MD013:
+  line_length: 100
+
+# MD041/first-line-heading
+MD041: false

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2022, National Instruments Corp.
+Copyright (c) 2025, National Instruments Corp.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,5 +1,106 @@
-# `nitypes`
+| **Info**      | Data types for NI Python APIs |
+| :------------ | :-----------------------------|
+| **Author**    | National Instruments          |
 
-`nitypes` is a Python package that defines data types for NI Python APIs.
+# Table of Contents
 
-TODO: describe a project in detail, what it does, how to use it, etc.
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+  - [Documentation](#documentation)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+- [Installation](#installation)
+- [Waveforms](#waveforms)
+  - [Analog Waveforms](#analog-waveforms)
+  - [Complex Waveforms](#complex-waveforms)
+  - [Frequency Spectrums](#frequency-spectrums)
+- [Complex Numbers](#complex-numbers)
+  - [Complex Integers](#complex-integers)
+  - [Complex Number Conversion](#complex-number-conversion)
+- [Time](#time)
+  - [Time Conversion](#time-conversion)
+
+# About
+
+The `nitypes` Python package defines data types for NI Python APIs:
+
+- Analog and complex waveforms
+- Frequency spectrums
+- Complex integers
+- Time conversion
+
+NI created and supports this package.
+
+## Documentation
+
+See the [API Reference](https://nitypes.readthedocs.io/).
+
+## Operating System Support
+
+`nitypes` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+`nitypes` supports CPython 3.9+ and PyPy3.
+
+# Installation
+
+Installing NI driver Python APIs that support waveforms will automatically install `nitypes`.
+
+You can also directly install the `nitypes` package using `pip` or by listing it as a dependency in
+your project's `pyproject.toml` file.
+
+# Waveforms
+
+## Analog Waveforms
+
+The `nitypes.waveform.AnalogWaveform` class represents a single analog signal with timing
+information and extended properties (such as channel name and units). Multi-channel analog data is
+represented using a collection of waveforms, such as `list[nitypes.waveform.AnalogWaveform]`. For
+more details, see [Analog
+Waveforms](https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/waveform/index.html#analog-waveforms)
+in the API Reference.
+
+## Complex Waveforms
+
+The `nitypes.waveform.ComplexWaveform` class represents a complex-number signal, such as I/Q data,
+with timing information and extended properties (such as channel name and units). For more details,
+see [Complex
+Waveforms](https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/waveform/index.html#complex-waveforms)
+in the API Reference.
+
+## Frequency Spectrums
+
+The `nitypes.waveform.Spectrum` class represents a frequency spectrum with frequency range
+information and extended properties (such as channel name and units). For more details, see
+[Frequency
+Spectrums](https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/waveform/index.html#frequency-spectrums)
+in the API Reference.
+
+# Complex Numbers
+
+## Complex Integers
+
+`nitypes.complex.ComplexInt32DType` is a NumPy structured data type object representing a complex
+integer with 16-bit `real` and `imag` fields. This structured data type has the same memory layout
+as the NIComplexI16 C struct used by NI driver APIs. For more details, see [Complex
+Integers](https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/complex/index.html#complex-integers)
+in the API Reference.
+
+## Complex Number Conversion
+
+You can use the `nitypes.complex.convert_complex()` function to convert complex-number NumPy arrays
+between `nitypes.complex.ComplexInt32DType` and the standard `np.complex64` and `np.complex128` data
+types. For more details, see [Complex >>
+Conversion](https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/complex/index.html#conversion)
+in the API Reference.
+
+# Time
+
+## Time Conversion
+
+You can use the `nitypes.time.convert_datetime()` and `nitypes.time.convert_timedelta()` functions
+to convert time values between the standard `datetime` library and the high-precision `hightime`
+library.For more details, see [Time >>
+Conversion](https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/time/index.html#conversion) in
+the API Reference.