Skip to content

Commit cbc3323

Browse files
committed
Improve README.md
- Move code conventions to `doc/conventions` - Add **Publications** and **License** sections to the README
1 parent 3836be5 commit cbc3323

File tree

2 files changed

+46
-9
lines changed

2 files changed

+46
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,38 @@ For benchmarking and evaluation see [bench]
5151
[bench]: ./bench
5252
[examples]: ./example
5353

54-
## Coding Practices
54+
### Publications
5555

56-
In this project I adopted some practices that made some parts of the code more
57-
readable to me. So please use them:
56+
- [Explode.js]: Filipe Marques, Mafalda Ferreira, André Nascimento, Miguel Coimbra, Nuno Santos, Limin Jia, and José Fragoso Santos.
57+
_"Automated Exploit Generation for Node.js Packages"_, in
58+
Proceedings of the 46th ACM SIGPLAN Conference on Programming Language Design and Implementation (PLDI'25), 2025.
5859

59-
#### File, Dir, and Path Variable Naming
60+
[Explode.js]: https://syssec.dpss.inesc-id.pt/papers/marques_pldi25.pdf
6061

61-
For **file** paths: `<something>_file`, e.g., `input_file`,
62-
`scheme_file`, `original_file`.
62+
### License
6363

64-
For **dir** paths: `<something>_dir`, e.g., `nas_dir` or `workspace_dir`.
64+
See [LICENSE].
6565

66-
For paths which may represent a **dir** or a **file**: `<something>_path`, e.g., `input_path`, `output_path`.
66+
MIT License
6767

68-
For the **data** of a file: `<something>_data`, e.g., `module_data`.
68+
Copyright (c) 2024 Explode-js
69+
70+
Permission is hereby granted, free of charge, to any person obtaining a copy
71+
of this software and associated documentation files (the "Software"), to deal
72+
in the Software without restriction, including without limitation the rights
73+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
74+
copies of the Software, and to permit persons to whom the Software is
75+
furnished to do so, subject to the following conditions:
76+
77+
The above copyright notice and this permission notice shall be included in all
78+
copies or substantial portions of the Software.
79+
80+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
81+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
82+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
83+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
84+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
85+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
86+
SOFTWARE.
87+
88+
[LICENSE]: ./LICENSE

doc/conventions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Conventions
2+
3+
## Coding
4+
5+
In this project I adopted some practices that made some parts of the code more
6+
readable to me. So please use them:
7+
8+
#### File, Dir, and Path Variable Naming
9+
10+
For **file** paths: `<something>_file`, e.g., `input_file`,
11+
`scheme_file`, `original_file`.
12+
13+
For **dir** paths: `<something>_dir`, e.g., `nas_dir` or `workspace_dir`.
14+
15+
For paths which may represent a **dir** or a **file**: `<something>_path`, e.g., `input_path`, `output_path`.
16+
17+
For the **data** of a file: `<something>_data`, e.g., `module_data`.

0 commit comments

Comments
 (0)