Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide initial description of application to README.md #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
# ilo nasin

The tool of nasin stuff!
*ilo nasin* is a web application for analyzing, comparing, and creating personal dictionaries for [toki pona](https://tokipona.org). It will be hosted at [nasin.li](https://nasin.li/) once it is in a working state, but is currently **in-development software**.

## License?
As toki pona is a philosophical language, *ilo nasin* contains many features dedicated to describing personal use and interpretation of the language, such as:

None! Need to agree on this one peeps :-)
* marking a word or a definition as *nasin nasa* (experimental use) or *musi taso* (jokes and non-serious use),
* the ability to provide commentary to the entire *nasin*, a word, or a single definition,
* the ability to specify parts of speech of a definition,
* and comparing two *nasin* pages in a special page.

## Roadmap

- [ ] Allow users to connect with Discord to "log in"
- [ ] Allow users to set a namespace for their account to post cleaner URLs
- [ ] Read *nasin* from JSON format
- [ ] Document *nasin* page format
- [ ] Edit *nasin* using a comfortable workflow
- [ ] Export *nasin* page to JSON format
- [ ] Implement the essentials for a profile page
- [ ] Post *nasin* onto an account and display it
- [ ] Delete *nasin*
- [ ] Pin *nasin* to the top of a user's profile page (even pages not necessarily from the user themselves)
- [ ] Compare *nasin* with a side-by-side view
- [ ] Draw/upload images of sitelen pona for specific words to show design and writing differences

## Installation

## Contributing

## License

*ilo nasin* is licensed under the [MIT License](https://github.com/zorbyte/ilo-nasin/blob/main/LICENSE).