@the_one_and_only/sourc v0.0.1

Sourc

Sourc is a text editor for the web, ready to use in your projects. It's lightweight, extensible, and embeddable. This repository is open-source and openly accepts contributions. See the Contributing section for more.

Features (still WIP)

In Progress

• The rest of the basic text editing features

Fully implemented

• Basic text input including:
  • Single character input
  • Single character deleting
  • Arrow key movement
• Plugin based code injection system.
• A powerful, simple to use logging system.

This is a synopsis. See CHANGLELOG.md for up to date changes

Installation

Install Sourc with npm

  npm install @the_one_and_only/sourc
  cd your-project

Take note that you will need a webpacker and some sort of dev server environment to run your webpage.

Contributing

Contributions are welcome and appreciated!

Please see contributing.md for rules and regulations about contributing.

To get started, clone this repo:

git clone https://github.com/Th3OneAndOnly/Sourc sourc-dev
cd sourc-dev

Make another folder to test in, and link the npm:

npm link
mkdir test
cd test
npm link sourc

Next, hack away! Thank you so much for making a contribution, please make a pull request in the repo after checking your PR with contributing.md.

Please adhere to this project's code of conduct.

Support

For support, email 209theoneandonly@gmail.com or create a Github Issue.

License

MIT

Special thanks to readme.so for helping me make this README!