Skip to content

Commit 4aad99c

Browse files
committed
CONTRIBUTING.md edits for typescript
1 parent 45ab568 commit 4aad99c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CONTRIBUTING.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -218,18 +218,19 @@ The contents of the repository are structured as follows:
218218

219219
### Multilanguage Support
220220

221-
The ccxt library is available in three different languages (more to come). We encourage developers to design *portable* code, so that a single-language user could read the code in other languages and understand it easily. This helps the adoption of the library. The main goal is to provide a generalized, unified, consistent and robust interface to as many existing cryptocurrency exchanges as possible.
221+
The ccxt library is available in several different languages (TypeScript, JavaScript, Python, PHP, C# and more to come). We encourage developers to design *portable* code, so that a single-language user could read the code in other languages and understand it easily. This helps the adoption of the library. The main goal is to provide a generalized, unified, consistent and robust interface to as many existing cryptocurrency exchanges as possible.
222222

223-
At first, all language-specific versions were developed in parallel, but separately from each other. But when it became too hard to maintain and keep the code consistent among all supported languages we have decided to switch to what we call a *source/generated* process. There is now a single source version in one language, that is JavaScript. Other language-specific versions are syntactically derived (transpiled, generated) automatically from the source version. But it doesn't mean that you have to be a JS coder to contribute. The portability principle allows Python and PHP devs to effectively participate in developing the source version as well.
223+
At first, all language-specific versions were developed in parallel, but separately from each other. But when it became too hard to maintain and keep the code consistent among all supported languages we have decided to switch to what we call a *source/generated* process. There is now a single source version in one language, that is TypeScript. Other language-specific versions are syntactically derived (transpiled, generated) automatically from the source version. But it doesn't mean that you have to be a TS or a JS coder to contribute. The portability principle allows Python and PHP devs to effectively participate in developing the source version as well.
224224

225225
The module entry points are:
226226
- `./python/__init__.py` for the Python pip package
227227
- `./python/async/__init__.py` for the Python 3.5.3+ ccxt.async_support subpackage
228-
- `./ccxt.js` for the Node.js npm package
228+
- `./js/ccxt.js` for the Node.js npm package
229+
- `./ts/ccxt.ts` for TypeScript
229230
- `./dist/ccxt.browser.js` for the browser bundle
230231
- `./ccxt.php` for PHP
231232

232-
Generated versions and docs are transpiled from the source `ccxt.js` file and files in `./js/` by the `npm run build` command.
233+
Generated versions and docs are transpiled from the source `ts/src` folder by the `npm run build` command.
233234

234235
### Transpiled (generated) files
235236

0 commit comments

Comments
 (0)